Lens Data Dictionary
Last updated on July 30, 2025 at 16:29 UTC
ActivityStateEvents.enterView
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.Category Type | STRING | Identifies the category type of an event or activity. |
payload.value.eventData.Session name | STRING | Identifies the name of the session in activity state events. |
payload.value.eventData.View name | STRING | Identifies the name of the view in enter view activity state events. |
payload.value.eventData.categoryType | STRING | Identifies the category type of an event or error occurrence in the system or application. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.sessionName | STRING | Identifies the session name associated with an event. |
payload.value.eventData.viewName | STRING | Identifies the name of the current view or application being used. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
ActivityStateEvents.exitView
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.viewName | STRING | Identifies the name of the current view or application being used. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
ActivityStateEvents.trackClick
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.Category Type | STRING | Identifies the category type of an event or activity. |
payload.value.eventData.ID | STRING | Identifies the specific UI element that triggered an event. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
ActivityStateEvents.trackCrash
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.categoryType | STRING | Identifies the category type of an event or error occurrence in the system or application. |
payload.value.eventData.crashDetails | STRING | Contains detailed information about application crashes and system errors. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.viewName | STRING | Identifies the name of the current view or application being used. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
appClose
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.appName | STRING | Identifies the application name during start and close events. |
payload.data.closeReason | STRING | Indicates the reason for application closure. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.lastUpdatedOn | STRING | Stores the timestamp of the last update for various application events. |
payload.data.packageName | STRING | Identifies the package name of the application being started or closed. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionCode | NUMBER | Indicates the version code of the application during start and close events. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
appsInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.Apps | OBJECT[] | See payload.data.Apps[] definition |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.provider | STRING | Identifies the provider of the payload data in various communication applications. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
appsInfo: payload.data.Apps[]
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the name of an application in the system. |
isEnabled | BOOLEAN | Indicates whether an application is enabled or disabled. |
isPrimary | BOOLEAN | Indicates whether an application is the primary one. |
Packages | OBJECT[] | See payload.data.Apps[].Packages[] definition |
appsInfo: payload.data.Apps[].Packages[]
Field Name | Data Type | Description |
---|---|---|
lastUpdatedOn | STRING | Stores the last update timestamp for application packages. |
packageName | STRING | Identifies the package name of an installed application. |
versionCode | NUMBER | Stores the version code of installed application packages. |
versionInfo | STRING | Specifies the version information of installed application packages. |
appStart
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.activityName | STRING | Identifies the name of the activity being launched when an application starts. |
payload.data.appName | STRING | Identifies the application name during start and close events. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.intentName | STRING | Identifies the intent name associated with an application start event. |
payload.data.lastUpdatedOn | STRING | Stores the timestamp of the last update for various application events. |
payload.data.packageName | STRING | Identifies the package name of the application being started or closed. |
payload.data.startReason | STRING | Indicates the reason for starting an application. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionCode | NUMBER | Indicates the version code of the application during start and close events. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
BLF_SCA
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.BLF.Attendant | STRING | Identifies the attendant's SIP address in BLF events. |
payload.data.BLF.configuredBlfCount | STRING | Indicates the total number of configured BLF entries. |
payload.data.BLF.details | OBJECT[] | See payload.data.BLF.details[] definition |
payload.data.BLF.droppedNotificationCount | STRING | Indicates the number of dropped notifications for a specific event. |
payload.data.BLF.eventMonotonicTime | STRING | Represents the event monotonic time in a specific format for various system events. |
payload.data.SCA.configuredSCACount | STRING | Indicates the number of configured secondary call appearances. |
payload.data.SCA.details | OBJECT[] | See payload.data.SCA.details[] definition |
payload.data.SCA.eventMonotonicTime | STRING | Represents the event monotonic time in a specific format for SCA events. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
BLF_SCA: payload.data.BLF.details[]
Field Name | Data Type | Description |
---|---|---|
actionCount | STRING | Indicates the number of actions performed in a specific event. |
notifyCount | STRING | Indicates the number of notifications for a specific event. |
user | STRING | Identifies the user associated with a specific session or call detail record. |
BLF_SCA: payload.data.SCA.details[]
Field Name | Data Type | Description |
---|---|---|
actionCount | STRING | Represents the number of actions performed in a specific SCA details instance. |
notifyCount | STRING | Indicates the number of notifications for a specific event. |
registered | STRING | Indicates whether a supplementary service is registered or not. |
user | STRING | Identifies the user associated with a specific SCA event detail. |
callConnect
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.callDirection | STRING | Indicates the direction of a call or connection. |
payload.data.callId | STRING | Identifies a unique call identifier for various telecommunication events. |
payload.data.callSpeed | STRING | Indicates the call speed during a call connection event. |
payload.data.callStatus | STRING | Indicates the current status of a phone call. |
payload.data.protocolType | STRING | Identifies the protocol used for communication in various events. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
cdr
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.callDirection | STRING | Indicates the direction of a call or connection. |
payload.data.callDuration | STRING | Represents the duration of a call in seconds. |
payload.data.callId | STRING | Identifies a unique call identifier for various telecommunication events. |
payload.data.callRate | STRING | Specifies the rate of the call in the call details record. |
payload.data.disconnectInfo | STRING | Indicates the reason for a call disconnect in a call details record. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.localTag | STRING | Identifies a unique local tag for various network events and records. |
payload.data.protocolType | STRING | Identifies the protocol used for communication in various events. |
payload.data.remoteParty | STRING | Identifies the remote party's phone number or name in a call details record. |
payload.data.remoteTag | STRING | Identifies a unique remote tag for various network events and records. |
payload.data.startTime | STRING | Represents the start time of an event in ISO 8601 format. |
payload.data.transferredTo | STRING | Identifies the target of a call transfer operation in a call details record. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.user | STRING | Contains the user's phone number or identifier in various formats. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.ext | STRING | Contains additional call detail information in JSON format. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
payload.user | STRING | Identifies the user associated with a call details record event. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
com.poly.lens.command.c10
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload | STRING | Contains JSON data for device configuration and software updates. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceEvent.deviceAttachment
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.attachmentState | NUMBER | Indicates the state of device attachment as a numeric value. |
payload.value.eventData.displayName | STRING | Identifies the display name of a device or attached peripheral. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceEvent.deviceHealthInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.bluetoothConnected | BOOLEAN | Indicates whether a Bluetooth connection is currently established. |
payload.value.eventData.cpu1CoreCelsiusTemp | NUMBER | Reports the temperature of the first CPU core in degrees Celsius. |
payload.value.eventData.cpu2CoreCelsiusTemp | NUMBER | Reports the temperature of the second CPU core in degrees Celsius. |
payload.value.eventData.cpuLevel | NUMBER | Indicates the current CPU usage level of a device. |
payload.value.eventData.cpuLevelAvg | NUMBER | Represents the average CPU usage level of a device. |
payload.value.eventData.cpuThrottleInfo | STRING[] | Reports CPU throttle information for device health monitoring events. |
payload.value.eventData.crashedServices | STRING[] | Identifies services that have crashed on the device with crash frequencies. |
payload.value.eventData.deviceOrientationNormal | BOOLEAN | Indicates whether the device orientation is normal or not. |
payload.value.eventData.diskUtilization | STRING | Reports disk utilization percentages for various storage partitions and devices. |
payload.value.eventData.ethernetErrors.rx_errors | NUMBER | Reports the total number of receive errors on an ethernet connection. |
payload.value.eventData.ethernetErrors.tx_errors | NUMBER | Reports the total number of transmission errors on an ethernet connection. |
payload.value.eventData.fanSpeed | NUMBER | Indicates the current speed of a device's fan in revolutions per minute. |
payload.value.eventData.gpuCoreCelsiusTemp | NUMBER | Reports the current temperature of the GPU core in degrees Celsius. |
payload.value.eventData.internalAmbientCelsiusTemp | NUMBER | Reports the internal ambient temperature in degrees Celsius. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.memoryUtilization | NUMBER | Reports the current memory utilization of a device in bytes. |
payload.value.eventData.memoryUtilizationAvg | NUMBER | Reports the average memory utilization of a device. |
payload.value.eventData.memoryUtilizationAvgPct | NUMBER | Reports the average percentage of memory utilization for device health monitoring purposes. |
payload.value.eventData.memoryUtilizationPct | NUMBER | Reports the percentage of memory utilized by the device. |
payload.value.eventData.networkLoad | NUMBER | Represents the network load value as a numeric measurement. |
payload.value.eventData.openFileCount | NUMBER | Indicates the number of open files on a device during a health information event. |
payload.value.eventData.polyCpuUsed | NUMBER | Represents the percentage of CPU usage for a device's poly core. |
payload.value.eventData.polyMemUsage | OBJECT[] | See payload.value.eventData.polyMemUsage[] definition |
payload.value.eventData.swapUtilization | STRING | Represents the swap utilization of a device in kilobytes. |
payload.value.eventData.tombstones | STRING[] | : |
payload.value.eventData.uptime | STRING | Indicates the duration a device has been continuously operational. |
payload.value.eventData.usbPeripherals | STRING[] | Identifies connected USB peripherals by their device paths. |
payload.value.eventData.wifiCelsiusTemp | NUMBER | Represents the current WiFi temperature in degrees Celsius. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceEvent.deviceHealthInfo: payload.value.eventData.polyMemUsage[]
Field Name | Data Type | Description |
---|---|---|
processName | STRING | Identifies the process name for memory usage in device health information events. |
usedMemory | NUMBER | Reports the amount of used memory in the device's polyMemUsage data. |
DeviceEvent.deviceMediaEvent
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.LOG_TAG | STRING | Identifies the log tag for device media events. |
payload.value.eventData.mediaSessionID | STRING | Identifies a unique media session identifier for device media events. |
payload.value.eventData.mediaSource | STRING | Identifies the source of media played on a device. |
payload.value.eventData.mediaStatus | STRING | Indicates the status of media playback on a device. |
payload.value.eventData.screenResolution | STRING | Specifies the screen resolution of a device in various formats. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceEvent.DfuFailure
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.archiveFile | STRING | Specifies the path to the archive file for device firmware updates. |
payload.value.eventData.deviceId | STRING | Identifies the device with a unique identifier string. |
payload.value.eventData.failureReason | STRING | Indicates the reason for device firmware update failure. |
payload.value.eventData.percentageComplete | STRING | Indicates the percentage of completion for a device firmware update event. |
payload.value.eventData.pid | STRING | Identifies the process identifier associated with a device firmware update failure event. |
payload.value.eventData.subFile | STRING | Contains additional data related to device firmware update failure events. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.AcousticAggregates
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.batchedData | OBJECT[] | See payload.value.eventData.batchedData[] definition |
payload.value.eventData.lensDeviceId | STRING | Identifies the device associated with various acoustic and call-related events and analytics. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.AcousticAggregates: payload.value.eventData.batchedData[]
Field Name | Data Type | Description |
---|---|---|
audioLevelAfterLimiting | NUMBER | Represents the audio level after limiting in acoustic-related events. |
audioLevelBeforeLimiting | NUMBER | Represents the audio level before limiting in acoustic events. |
callId | STRING | Identifies a unique call identifier for various device information events. |
duration | NUMBER | Represents the duration of acoustic data in milliseconds. |
durationThreshold | NUMBER | Represents the duration threshold value for acoustic events and device data. |
incidentTime | STRING | Represents the timestamp of an incident or event occurrence. |
lineType | STRING | Identifies the type of line for various device-related events and analytics. |
periodicity | NUMBER | Indicates the time interval between data batches in milliseconds. |
DeviceInfo.AcousticIncident
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.batchedData | OBJECT[] | See payload.value.eventData.batchedData[] definition |
payload.value.eventData.lensDeviceId | STRING | Identifies the device associated with various acoustic and call-related events and analytics. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.AcousticIncident: payload.value.eventData.batchedData[]
Field Name | Data Type | Description |
---|---|---|
activeLimiters | STRING[] | Identifies active limiters in acoustic incident device information events. |
audioLevelAfterLimiting | NUMBER | Represents the audio level after limiting in acoustic-related events. |
audioLevelBeforeLimiting | NUMBER | Represents the audio level before limiting in acoustic events. |
callId | STRING | Identifies a unique call identifier for various device information events. |
durationThreshold | NUMBER | Represents the duration threshold value for acoustic events and device data. |
gainThreshold | NUMBER | Represents the minimum sound level required to trigger an acoustic incident detection event. |
incidentDuration | NUMBER | Represents the duration of an incident in numeric format. |
incidentTime | STRING | Represents the timestamp of an incident or event occurrence. |
limiterBitMask | NUMBER | Indicates a bitmask value for limiting device functionality during acoustic incidents. |
DeviceInfo.Analytics
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.updateTime | STRING | Represents the timestamp of an event update in numeric string format. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.AppActive
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.appName | STRING | Identifies the name of the application currently running on the device. |
payload.value.eventData.entranceReason | STRING | Specifies the reason for entering the application's active state. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.AppInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.apps | OBJECT[] | See payload.value.eventData.apps[] definition |
payload.value.eventData.lastUpdatedOn | STRING | Represents the timestamp of the last update in milliseconds since epoch time. |
payload.value.eventData.provider | STRING | Identifies the provider of event data for device information applications. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.AppInfo: payload.value.eventData.apps[]
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the name of an application installed on a device. |
appSize | NUMBER | Represents the size of an application in bytes. |
isEnabled | BOOLEAN | Indicates whether an application is enabled or disabled on the device. |
isPrimary | BOOLEAN | Indicates whether an application is the primary one on the device. |
lastUpdatedOn | STRING | Stores the timestamp of the last update for an application. |
packageName | STRING | Identifies the package name of an application installed on a device. |
versionInfo | STRING | Stores the version information of installed applications on a device. |
DeviceInfo.AppState
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.appName | STRING | Identifies the name of the application currently running on the device. |
payload.value.eventData.appState | STRING | Indicates the current application state of a device. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.callConnection
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.callDirection | STRING | Indicates the direction of a call, either incoming or outgoing. |
payload.value.eventData.callId | STRING | Identifies a unique call identifier for various device events and call detail records. |
payload.value.eventData.callID | STRING | Identifies a unique call identifier for various telecommunication events. |
payload.value.eventData.callSpeed | STRING | Represents the speed of a call in bits per second. |
payload.value.eventData.callStatus | STRING | Indicates the current status of a phone call or connection. |
payload.value.eventData.eventTime | STRING | Represents the timestamp of an event in ISO format. |
payload.value.eventData.lensDeviceId | STRING | Identifies the device associated with various acoustic and call-related events and analytics. |
payload.value.eventData.lineType | STRING | Identifies the type of phone line used for the call connection or service. |
payload.value.eventData.protocolType | STRING | Identifies the protocol used for voice or call connections and related events. |
payload.value.eventData.source | STRING | Identifies the source of event data for various device interactions. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.CallQoSInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.bitRateDataRx.audioJitter | NUMBER | Measures the audio jitter bit rate received during a call. |
payload.value.eventData.bitRateDataRx.audioPacketLoss | NUMBER | Measures the number of lost audio packets received during a call. |
payload.value.eventData.bitRateDataRx.audioProtocol | STRING | Identifies the audio protocol used for receiving bit rate data. |
payload.value.eventData.bitRateDataRx.audioRate | NUMBER | Represents the received audio bitrate in device call quality of service information events. |
payload.value.eventData.bitRateDataRx.contentVideoFormat | STRING | Specifies the video format of received content. |
payload.value.eventData.bitRateDataRx.contentVideoFrameRate | NUMBER | Represents the received video frame rate in bits per second. |
payload.value.eventData.bitRateDataRx.contentVideoProtocol | STRING | Specifies the video protocol used for receiving content. |
payload.value.eventData.bitRateDataRx.contentVideoRate | NUMBER | Represents the received video bitrate in call quality of service information events. |
payload.value.eventData.bitRateDataRx.contentVideoRateUsed | NUMBER | Represents the received video bitrate used in call quality of service information. |
payload.value.eventData.bitRateDataRx.totalRate | NUMBER | Represents the total received bitrate in a call quality of service information event. |
payload.value.eventData.bitRateDataRx.videoFormat | STRING | Specifies the video format of received bit rate data. |
payload.value.eventData.bitRateDataRx.videoFrameRate | NUMBER | Represents the video frame rate received by the device in bits per second. |
payload.value.eventData.bitRateDataRx.videoJitter | NUMBER | Measures the video jitter bit rate received during a call. |
payload.value.eventData.bitRateDataRx.videoPacketLoss | NUMBER | Measures the number of video packets lost during reception. |
payload.value.eventData.bitRateDataRx.videoProtocol | STRING | Specifies the video protocol used for receiving bitrate data. |
payload.value.eventData.bitRateDataRx.videoRate | NUMBER | Represents the received video bitrate in device call quality of service information events. |
payload.value.eventData.bitRateDataRx.videoRateUsed | NUMBER | Represents the received video bitrate used in call quality of service information. |
payload.value.eventData.bitRateDataTx.audioJitter | NUMBER | Measures the audio jitter bit rate in transmit direction for call quality of service information. |
payload.value.eventData.bitRateDataTx.audioPacketLoss | NUMBER | Represents the audio packet loss rate in bits per second during a call. |
payload.value.eventData.bitRateDataTx.audioProtocol | STRING | Identifies the audio protocol used for transmitting bit rate data. |
payload.value.eventData.bitRateDataTx.audioRate | NUMBER | Specifies the transmit audio bitrate in device call quality of service information events. |
payload.value.eventData.bitRateDataTx.contentVideoFormat | STRING | Specifies the video format of transmitted content. |
payload.value.eventData.bitRateDataTx.contentVideoFrameRate | NUMBER | Represents the video frame rate transmitted during a call. |
payload.value.eventData.bitRateDataTx.contentVideoProtocol | STRING | Specifies the video protocol used for transmitted content. |
payload.value.eventData.bitRateDataTx.contentVideoRate | NUMBER | Represents the transmitted video bitrate in call quality of service information events. |
payload.value.eventData.bitRateDataTx.contentVideoRateUsed | NUMBER | Represents the transmitted video rate used in call quality of service information events. |
payload.value.eventData.bitRateDataTx.totalRate | NUMBER | Represents the total transmission bit rate of a device during a call. |
payload.value.eventData.bitRateDataTx.videoFormat | STRING | Specifies the video format of transmitted data during a call. |
payload.value.eventData.bitRateDataTx.videoFrameRate | NUMBER | Represents the video frame rate transmitted during a call in bits per second. |
payload.value.eventData.bitRateDataTx.videoJitter | NUMBER | Measures the transmitted video jitter in bits per second for call quality monitoring. |
payload.value.eventData.bitRateDataTx.videoPacketLoss | NUMBER | Represents the transmitted video packet loss rate in bits per second. |
payload.value.eventData.bitRateDataTx.videoProtocol | STRING | Specifies the video protocol used for transmitting video data. |
payload.value.eventData.bitRateDataTx.videoRate | NUMBER | Represents the transmitted video bitrate in bits per second for device calls. |
payload.value.eventData.bitRateDataTx.videoRateUsed | NUMBER | Represents the transmitted video bitrate in bytes per second. |
payload.value.eventData.callDirection | STRING | Indicates the direction of a call, either incoming or outgoing. |
payload.value.eventData.callDuration | STRING | Represents the duration of a call in hours, minutes, and seconds format. |
payload.value.eventData.callId | STRING | Identifies a unique call identifier for various device events and call detail records. |
payload.value.eventData.callStartTime | STRING | Represents the start time of a call in ISO format. |
payload.value.eventData.callStatus | STRING | Indicates the current status of a phone call or connection. |
payload.value.eventData.callTermination | BOOLEAN | Indicates whether a call was terminated normally or abnormally. |
payload.value.eventData.callType | STRING | Identifies the type of call in a device's call quality of service information. |
payload.value.eventData.conferenceId | STRING | Identifies the conference identifier for call quality of service information. |
payload.value.eventData.contentUsed | BOOLEAN | Indicates whether content was used during a call quality of service event. |
payload.value.eventData.destAddr | STRING | Stores the destination address of a call or communication event. |
payload.value.eventData.destName | STRING | Identifies the destination name or address in a call event. |
payload.value.eventData.disconnectCauseCode | STRING | Indicates the reason for a call disconnection with a specific code. |
payload.value.eventData.encryptionUsed | BOOLEAN | Indicates whether encryption was used for the call. |
payload.value.eventData.precedenceLevel | STRING | Indicates the priority level of a call quality of service event. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.cdrInfo
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.answeredInSoftphone | BOOLEAN | Indicates whether a call was answered using a softphone. |
payload.value.eventData.callDirection | STRING | Indicates the direction of a call, either incoming or outgoing. |
payload.value.eventData.callDuration | STRING | Represents the duration of a call in hours, minutes, and seconds format. |
payload.value.eventData.callDurationMs | NUMBER | Represents the duration of a call in milliseconds. |
payload.value.eventData.callId | STRING | Identifies a unique call identifier for various device events and call detail records. |
payload.value.eventData.callRate | STRING | Specifies the call rate in bits per second for a call details record. |
payload.value.eventData.dialString | STRING | Contains the dial string used to initiate a call in various communication events. |
payload.value.eventData.disconnectInfo | STRING | Describes the reason for a call disconnect or termination event. |
payload.value.eventData.endTime | STRING | Represents the end time of an event in ISO format. |
payload.value.eventData.experienceSummary.audioProtocolRx | STRING | Specifies the audio protocol received by the device. |
payload.value.eventData.experienceSummary.audioProtocolTx | STRING | Specifies the audio protocol used for transmission in a call. |
payload.value.eventData.experienceSummary.avgJitterRx | NUMBER | Measures average jitter received in network communications. |
payload.value.eventData.experienceSummary.avgJitterTx | NUMBER | Measures average transmit jitter in network communications. |
payload.value.eventData.experienceSummary.avgLatencyRx | NUMBER | Measures the average latency received in network communications. |
payload.value.eventData.experienceSummary.avgLatencyTx | NUMBER | Represents the average transmit latency in network transactions. |
payload.value.eventData.experienceSummary.avgPacketsLostRx | NUMBER | Reports the average number of packets lost during reception. |
payload.value.eventData.experienceSummary.avgPacketsLostTx | NUMBER | Represents the average number of packets lost during transmission. |
payload.value.eventData.experienceSummary.avgPercentPacketLossRx | NUMBER | Measures average packet loss received as a percentage. |
payload.value.eventData.experienceSummary.avgPercentPacketLossTx | NUMBER | Measures average packet loss during transmission as a percentage value. |
payload.value.eventData.experienceSummary.maxJitterRx | NUMBER | Measures the maximum received jitter in network communications. |
payload.value.eventData.experienceSummary.maxJitterTx | NUMBER | Measures the maximum transmission jitter experienced during a call. |
payload.value.eventData.experienceSummary.maxLatencyRx | NUMBER | Measures the maximum latency received in a network experience. |
payload.value.eventData.experienceSummary.maxLatencyTx | NUMBER | Measures the maximum transmission latency in network communications. |
payload.value.eventData.experienceSummary.precedenceLevel | STRING | Indicates the precedence level of the device experience summary. |
payload.value.eventData.experienceSummary.totalH320Errors | NUMBER | Counts the total number of H320 errors in a call details record. |
payload.value.eventData.experienceSummary.videoFormatRx | STRING | Specifies the video format received by the device. |
payload.value.eventData.experienceSummary.videoFormatTx | STRING | Specifies the video transmission format used by the device. |
payload.value.eventData.experienceSummary.videoProtocolRx | STRING | Specifies the video protocol received by the device. |
payload.value.eventData.experienceSummary.videoProtocolTx | STRING | Indicates the video transmission protocol used by the device. |
payload.value.eventData.lensDeviceId | STRING | Identifies the device associated with various acoustic and call-related events and analytics. |
payload.value.eventData.lineType | STRING | Identifies the type of phone line used for the call connection or service. |
payload.value.eventData.local.name | STRING | Identifies a local name associated with a device or location. |
payload.value.eventData.local.uri | STRING | Identifies the URI of the local endpoint in various communication protocols. |
payload.value.eventData.name | STRING | Indicates the status or action of a device event. |
payload.value.eventData.pluginId | STRING | Identifies the plugin identifier associated with device information events. |
payload.value.eventData.protocolType | STRING | Identifies the protocol used for voice or call connections and related events. |
payload.value.eventData.relatedDeviceEvent | STRING | Indicates the type of event related to a device interaction or status change. |
payload.value.eventData.remote.name | STRING | Identifies the remote name associated with a call details record event. |
payload.value.eventData.remote.uri | STRING | Identifies the remote uniform resource identifier for various communication protocols. |
payload.value.eventData.remoteParty | STRING | Identifies the remote party in a call details record event. |
payload.value.eventData.softphoneVersion | STRING | Stores the version of the softphone application in use. |
payload.value.eventData.source | STRING | Identifies the source of event data for various device interactions. |
payload.value.eventData.startTime | STRING | Represents the start time of an event in ISO format. |
payload.value.eventData.userAction | STRING | Identifies the type of user action triggering the device event. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.ConversationAnalytics
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.batchedData | OBJECT[] | See payload.value.eventData.batchedData[] definition |
payload.value.eventData.lensDeviceId | STRING | Identifies the device associated with various acoustic and call-related events and analytics. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.ConversationAnalytics: payload.value.eventData.batchedData[]
Field Name | Data Type | Description |
---|---|---|
callId | STRING | Identifies a unique call identifier for various device information events. |
farTalk | NUMBER | Measures the far talk time in conversation analytics events. |
incidentTime | STRING | Represents the timestamp of an incident or event occurrence. |
lineType | STRING | Identifies the type of line for various device-related events and analytics. |
nearTalk | NUMBER | Measures the near-talk audio level in conversation analytics events. |
overTalk | NUMBER | Measures the duration of overlapping talk in a conversation. |
periodicity | NUMBER | Indicates the time interval between data batches in milliseconds. |
rxLevelIn | NUMBER | Represents the received signal strength level in a device's conversation analytics data. |
rxLevelOut | NUMBER | Measures the signal strength of received data in decibels. |
rxNoiseIn | NUMBER | Represents the received noise level in decibels for wireless communication. |
rxNoiseOut | NUMBER | Measures the received noise level in decibels for wireless communication. |
rxPeakIn | NUMBER | Represents the peak receive signal strength in a batch of data. |
rxPeakOut | NUMBER | Measures the peak receive signal strength in decibels. |
rxVolume | NUMBER | Measures the volume of received audio signals in decibels. |
sideToneVolume | NUMBER | Represents the volume of side tone audio in conversation analytics data. |
txLevelIn | NUMBER | Represents the transmission level of a signal in a device conversation analytics event. |
txLevelOut | NUMBER | Represents the transaction level output in decibels for audio signals. |
txNoiseIn | NUMBER | Represents the noise level measured in decibels during a transaction. |
txNoiseOut | NUMBER | Represents the noise level of outgoing transmissions in decibels. |
txPeakIn | NUMBER | Represents the peak inbound transaction volume in a batch of network traffic data. |
txPeakOut | NUMBER | Represents the peak outgoing transmission power in decibels. |
txVolume | NUMBER | Represents the transaction volume in a batch of event data. |
type | STRING | Identifies the type of event data in a batched data record. |
DeviceInfo.deviceConfigRecord
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.otherItems | OBJECT[] | See payload.value.eventData.otherItems[] definition |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.deviceConfigRecord: payload.value.eventData.otherItems[]
Field Name | Data Type | Description |
---|---|---|
isInitial | BOOLEAN | Indicates whether an item is the initial configuration for the device. |
key | STRING | Identifies various device configuration settings and properties in a device information record. |
value | STRING | Stores various device configuration data as string values. |
DeviceInfo.deviceInfoState
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.entities | OBJECT[] | See payload.value.eventData.entities[] definition |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.deviceInfoState: payload.value.eventData.entities[]
Field Name | Data Type | Description |
---|---|---|
capabilities | STRING[] | Lists the capabilities of a device entity in the event data. |
connected | BOOLEAN | Indicates whether a device is currently connected to the network. |
connections | OBJECT[] | See payload.value.eventData.entities[].connections[] definition |
connectionTypeToHostPc | STRING | Indicates the type of connection to the host PC. |
deviceId | STRING | Identifies the device using a unique string identifier. |
deviceName | STRING | Identifies the name of a device in various IoT events and messages. |
deviceSpecificInfo.buildCode | STRING | Identifies the device's build code in device information events. |
deviceSpecificInfo.color | STRING | Specifies the color of a device in device information events. |
deviceSpecificInfo.componentVersions.base | STRING | Stores the base version of a device component. |
deviceSpecificInfo.componentVersions.bluetooth | STRING | Stores the Bluetooth component version of a device. |
deviceSpecificInfo.componentVersions.headset | STRING | Stores version information for the headset component of a device. |
deviceSpecificInfo.componentVersions.pic | STRING | Stores the version of the picture component in device information events. |
deviceSpecificInfo.componentVersions.tuning | STRING | Stores version information for device component tuning configurations. |
deviceSpecificInfo.componentVersions.usb | STRING | Stores version information for USB components in device-specific data. |
deviceSpecificInfo.formFactor | STRING | Describes the physical form of a device, such as smartphone or tablet. |
deviceSpecificInfo.genesSerialNumber | STRING | Identifies the serial number of a device's genetic module. |
deviceSpecificInfo.headsetType | STRING | Identifies the type of headset connected to a device. |
deviceSpecificInfo.ipv4Address | STRING | Stores the IPv4 address of a device in various network events. |
deviceSpecificInfo.macAddress | STRING | Identifies the device's media access control address. |
deviceSpecificInfo.modelId | STRING | Identifies the device model for various device information events. |
deviceSpecificInfo.tattooSerialNumber | STRING | Identifies a unique serial number for device tracking purposes. |
deviceSpecificInfo.type | STRING | Identifies the type of device-specific information in various IoT device events. |
deviceSpecificInfo.versionHash | STRING | Identifies a unique version of device-specific information. |
deviceType | STRING | Identifies the type of device in various IoT events and messages. |
hardwareModel | STRING | Identifies the hardware model of a device in various events. |
isUpdateAvailable | BOOLEAN | Indicates whether a device update is available. |
manufacturer | STRING | Identifies the device manufacturer in various device information events. |
productId | STRING | Identifies the product identifier for various device information events. |
productName | STRING | Identifies the product name of a device in various events. |
proxyAgent | STRING | Identifies the proxy agent used by a device. |
proxyAgentId | STRING | Identifies the proxy agent associated with a device. |
proxyAgentVersion | STRING | Specifies the version of the proxy agent used by the device. |
softwareVersion | STRING | Stores the version of software installed on a device. |
state | STRING | Indicates the current state of a device or entity. |
updateVersion | STRING | Indicates the version of updated device information entities. |
vendorId | STRING | Identifies the vendor of a device in various IoT events and messages. |
DeviceInfo.deviceInfoState: payload.value.eventData.entities[].connections[]
Field Name | Data Type | Description |
---|---|---|
connected | BOOLEAN | Indicates whether a device connection is currently established or not. |
from | STRING | Identifies the source entity in a connection for various device information events. |
fullName | STRING | Identifies a unique entity connection full name in device information events. |
STRING | Identifies a unique mail connection entity in device information events. | |
protocol | STRING | Specifies the protocol used for device connections and authentication. |
stats.bitrate | NUMBER | Represents the bitrate of a device connection in bytes per second. |
stats.type | STRING | Identifies the type of statistic for device connections. |
targetEntityType | STRING | Identifies the type of target entity in a connection, such as device or user. |
to | STRING | Identifies the destination of a connection in an authentication event. |
type | STRING | Identifies the type of connection for a device entity. |
userName | STRING | Identifies a unique user or device entity in the system. |
via | STRING[] | Specifies the connection path for device communication. |
DeviceInfo.deviceInfoUpdate
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.capabilities | STRING[] | Lists device capabilities in a device information update event. |
payload.value.eventData.connected | BOOLEAN | Indicates whether a device is currently connected or not. |
payload.value.eventData.connections | OBJECT[] | See payload.value.eventData.connections[] definition |
payload.value.eventData.deviceId | STRING | Identifies the device with a unique identifier string. |
payload.value.eventData.deviceName | STRING | Identifies the name of a device in various networked equipment and peripherals. |
payload.value.eventData.deviceSpecificInfo.buildCode | STRING | Identifies the device's build code for device information updates. |
payload.value.eventData.deviceSpecificInfo.color | STRING | Represents the color of a device in various informational updates. |
payload.value.eventData.deviceSpecificInfo.componentVersions.base | STRING | Stores version information for device components in device info update events. |
payload.value.eventData.deviceSpecificInfo.componentVersions.bluetooth | STRING | Stores the Bluetooth component version in the device information update event. |
payload.value.eventData.deviceSpecificInfo.componentVersions.headset | STRING | Stores the version of the headset component in device information updates. |
payload.value.eventData.deviceSpecificInfo.componentVersions.pic | STRING | Stores the version of the pic component in device-specific information. |
payload.value.eventData.deviceSpecificInfo.componentVersions.tuning | STRING | Stores the tuning version of a device component. |
payload.value.eventData.deviceSpecificInfo.componentVersions.usb | STRING | Stores the version of the USB component in device information updates. |
payload.value.eventData.deviceSpecificInfo.formFactor | STRING | Indicates the device's form factor, such as left or right. |
payload.value.eventData.deviceSpecificInfo.genesSerialNumber | STRING | Identifies a device using its unique serial number. |
payload.value.eventData.deviceSpecificInfo.headsetType | STRING | Indicates the type of headset connected to the device. |
payload.value.eventData.deviceSpecificInfo.ipv4Address | STRING | Specifies the device's IPv4 address in various network configurations. |
payload.value.eventData.deviceSpecificInfo.macAddress | STRING | Identifies the device's media access control address. |
payload.value.eventData.deviceSpecificInfo.modelId | STRING | Identifies the device model using a unique identifier string. |
payload.value.eventData.deviceSpecificInfo.tattooSerialNumber | STRING | Identifies a device by its unique serial number. |
payload.value.eventData.deviceSpecificInfo.type | STRING | Identifies the type of device-specific information in device info update events. |
payload.value.eventData.deviceSpecificInfo.versionHash | STRING | Identifies the version hash of device-specific information in device info update events. |
payload.value.eventData.deviceType | STRING | Identifies the type of device reporting event data. |
payload.value.eventData.isUpdateAvailable | BOOLEAN | Indicates whether a device information update is available. |
payload.value.eventData.manufacturer | STRING | Identifies the device manufacturer in various device information events. |
payload.value.eventData.productId | STRING | Identifies the product associated with device information updates and primary device events. |
payload.value.eventData.productName | STRING | Identifies the product name of a device in an update event. |
payload.value.eventData.proxyAgent | STRING | Identifies the proxy agent used for device information updates and primary device events. |
payload.value.eventData.proxyAgentId | STRING | Identifies a unique proxy agent identifier for device information updates. |
payload.value.eventData.proxyAgentVersion | STRING | Stores the version of the proxy agent in device information updates. |
payload.value.eventData.softwareVersion | STRING | Indicates the version of software installed on the device. |
payload.value.eventData.updateType | STRING | Indicates the type of update made to device information. |
payload.value.eventData.updateVersion | STRING | Specifies the version of the updated device information. |
payload.value.eventData.vendorId | STRING | Identifies the vendor of a device in various update events. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.deviceInfoUpdate: payload.value.eventData.connections[]
Field Name | Data Type | Description |
---|---|---|
connected | BOOLEAN | Indicates whether a device connection is currently established or not. |
from | STRING | Identifies the source of a network connection. |
protocol | STRING | Identifies the communication protocol used by a device connection. |
stats.bitrate | NUMBER | Reports the bitrate of a device connection in bytes per second. |
stats.type | STRING | Identifies the type of connection for device communication protocols. |
targetEntityType | STRING | Identifies the type of target entity in device information update events. |
to | STRING | Identifies the destination of a connection in various network events. |
type | STRING | Identifies the type of connection for device information updates. |
via | STRING[] | Identifies the connection path for device information updates. |
DeviceInfo.FaceTracking
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
deviceId | STRING | Identifies the device associated with various events and analytics. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventdata.count | STRING | Indicates the number of events or occurrences in device face tracking data. |
payload.value.eventData.count | NUMBER | STRING | Represents the number of events or items in the event data payload. |
payload.value.eventData.deviceId | STRING | Identifies the device with a unique identifier string. |
payload.value.eventData.mac | STRING | Identifies the media access control address of a device. |
payload.value.eventData.smallestFaceHeight | STRING | Specifies the minimum height of a detected face in pixels. |
payload.value.eventdata.sourceId | NUMBER | Identifies the source of event data in device-related messages. |
payload.value.eventData.sourceId | NUMBER | STRING | Identifies the source of event data in device information messages. |
payload.value.eventdata.updateTime | NUMBER | Represents the timestamp of the last update in milliseconds since epoch time. |
payload.value.eventData.updateTime | NUMBER | STRING | Represents the timestamp of an event update in numeric string format. |
payload.value.eventtime | STRING | Represents the timestamp when an event occurs in ISO format. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventtype | STRING | Indicates the type of event triggered by a device. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventversion | STRING | Specifies the version of the event being reported in device messages. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.networkInfo
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.interfaces | OBJECT[] | See payload.value.eventData.interfaces[] definition |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.networkInfo: payload.value.eventData.interfaces[]
Field Name | Data Type | Description |
---|---|---|
802.1xStatus | BOOLEAN | STRING | Indicates the status of 802.1x authentication for a network interface. |
cdpStatus | STRING | Indicates the status of the Cisco Discovery Protocol in network information events. |
connectionMode | STRING | Indicates the mode of connection for network interfaces. |
connectionSpeed | STRING | Indicates the speed of the network connection in megabits per second. |
connectionType | STRING | Indicates the type of network connection used by the device. |
dnsAlternativeAddress | STRING | Specifies an alternative DNS address for the device's network interface. |
dnsDomain | STRING | Identifies the DNS domain associated with a network interface. |
dnsPrimaryAddress | STRING | Specifies the primary DNS address of a device's network interface. |
eapMethod | STRING | Specifies the authentication method used for network connections. |
ipv4Address | STRING | Specifies the IPv4 address of a network interface. |
ipv4AddressSource | STRING | Specifies the source of the IPv4 address for network interfaces. |
ipv4Gateway | STRING | Specifies the IPv4 gateway address for network interfaces. |
ipv4Subnet | STRING | Specifies the IPv4 subnet mask for network interfaces. |
ipv4Vlan | STRING | Specifies the IPv4 VLAN interface value for network information events. |
ipv6AddressSource | STRING | Specifies the source of the IPv6 address for network interfaces. |
ipv6GlobalAddress | STRING | Contains the IPv6 global address of a network interface. |
ipv6LinkLocalAddress | STRING | Specifies the IPv6 link local address of an interface on a device. |
ipv6ULA | STRING | Specifies the IPv6 Unique Local Address for network interfaces. |
lldpLocationInformation | STRING | Stores location information received from Link Layer Discovery Protocol messages. |
lldpNeighbors | STRING | Stores neighboring device information received through Link Layer Discovery Protocol. |
lldpStatus | STRING | Indicates the status of Link Layer Discovery Protocol on a network interface. |
ntpServer | STRING | Specifies the network time protocol server used for time synchronization. |
pcPortStatus | STRING | Indicates the status of a PC port on a network interface. |
provisioningProtocol | STRING | Specifies the protocol used for provisioning network interfaces on devices. |
security | STRING | Specifies the security protocol used by a network interface. |
ssid | STRING | Identifies the ssid of wireless network interfaces on devices. |
DeviceInfo.primaryDeviceInfo
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.eventMonotonicMillis | NUMBER | Represents the event timestamp in milliseconds since an arbitrary starting point. |
payload.value.eventData.hardwaremodel | STRING | Identifies the hardware model of a device in various events. |
payload.value.eventData.hardwareModel | STRING | Identifies the hardware model of a device in various events. |
payload.value.eventData.hardwarerevision | STRING | Identifies the hardware revision of a device. |
payload.value.eventData.hardwareRevision | STRING | Identifies the hardware revision of a device. |
payload.value.eventData.hostHardware | STRING | Describes host hardware details including manufacturer and architecture. |
payload.value.eventData.hostName | STRING | Identifies the hostname of a device in various network events. |
payload.value.eventData.hostOS | STRING | Identifies the operating system of the device hosting the event. |
payload.value.eventData.hostOSBuild | STRING | Specifies the operating system build version of the device. |
payload.value.eventData.hostOSVersion | STRING | Stores the operating system version of the device hosting the event. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.macaddress | STRING | Identifies the media access control address of a device. |
payload.value.eventData.macAddress | STRING | Identifies the media access control address of a device. |
payload.value.eventData.manufacturer | STRING | Identifies the device manufacturer in various device information events. |
payload.value.eventData.offsetgmt | STRING | Indicates the device's timezone offset from Greenwich Mean Time. |
payload.value.eventData.offsetGMT | STRING | Represents the timezone offset from Greenwich Mean Time. |
payload.value.eventData.productfamily | STRING | Identifies the product family of a device. |
payload.value.eventData.productFamily | STRING | Identifies the product family of a device in various events. |
payload.value.eventData.productId | STRING | Identifies the product associated with device information updates and primary device events. |
payload.value.eventData.proxyAgent | STRING | Identifies the proxy agent used for device information updates and primary device events. |
payload.value.eventData.proxyAgentId | STRING | Identifies a unique proxy agent identifier for device information updates. |
payload.value.eventData.proxyAgentVersion | STRING | Stores the version of the proxy agent in device information updates. |
payload.value.eventData.serialnumber | STRING | Identifies the device's unique serial number in various events. |
payload.value.eventData.serialNumber | STRING | Identifies a device by its unique serial number. |
payload.value.eventData.softwarebuild | STRING | Identifies the software build version of a device. |
payload.value.eventData.softwareBuild | STRING | Identifies the software build version of a device. |
payload.value.eventData.softwarerelease | STRING | Indicates the software release version of a device. |
payload.value.eventData.softwareRelease | STRING | Identifies the software release version of a device. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.remoteAccessInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.bytesReceived | NUMBER | Represents the total number of bytes received during a remote access event. |
payload.value.eventData.bytesSent | NUMBER | Represents the total number of bytes sent during a remote access event. |
payload.value.eventData.durationMs | NUMBER | Represents the duration of an event in milliseconds. |
payload.value.eventData.endedBy | STRING | Indicates the entity that ended a remote access session. |
payload.value.eventData.endReason | STRING | Indicates the reason for ending a remote access session or connection. |
payload.value.eventData.endTime | STRING | Represents the end time of an event in ISO format. |
payload.value.eventData.localIceCandidate | STRING | Contains local ICE candidate information for remote access events. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.remoteAdminVersion | STRING | Stores the version of the remote administration software. |
payload.value.eventData.remoteIceCandidate | STRING | Stores remote ice candidate details for network connections. |
payload.value.eventData.sessionId | STRING | Identifies a unique session for remote access information. |
payload.value.eventData.startResponseTime | STRING | Represents the start response time in ISO format. |
payload.value.eventData.startTime | STRING | Represents the start time of an event in ISO format. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.secondaryDeviceInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.attachedDevices | OBJECT[] | See payload.value.eventData.attachedDevices[] definition |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
DeviceInfo.secondaryDeviceInfo: payload.value.eventData.attachedDevices[]
Field Name | Data Type | Description |
---|---|---|
attachmentState | STRING | Indicates the state of device attachment for various events. |
CECEnabled | STRING | Indicates whether Consumer Electronics Control is enabled for a device. |
connectionType | STRING | Indicates the connection type of attached devices to the system. |
displayName | STRING | Identifies the display name of an attached device. |
ipAddress | STRING | Specifies the IP address of a connected device. |
macAddress | STRING | Identifies the media access control address of an attached device. |
peripheralType | STRING | Identifies the type of peripheral device attached to a system. |
refreshRate | STRING | Specifies the refresh rate of attached devices in device information events. |
resolution | STRING | Specifies the screen resolution of attached devices in device information events. |
serialNumber | STRING | Identifies the serial number of an attached device. |
softwareVersion | STRING | Indicates the software version of attached devices. |
status | STRING | Indicates the status of devices attached to a secondary device. |
Touchable | STRING | Indicates whether a device has a touch interface capability. |
vendor | STRING | Identifies the manufacturer of an attached device. |
DeviceInfo.serviceInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.authType | STRING | Specifies the authentication type used for device service information events. |
payload.value.eventData.baseDN | STRING | Identifies the base distinguished name in directory services. |
payload.value.eventData.defaultGroup | STRING | Specifies the default group identifier for device service information events. |
payload.value.eventData.displayName | STRING | Identifies the display name of a device or attached peripheral. |
payload.value.eventData.domain | STRING | Identifies the domain associated with the device service information. |
payload.value.eventData.email | STRING | Stores the email address associated with the device or service. |
payload.value.eventData.enabled | BOOLEAN | Indicates whether a device service is enabled or disabled. |
payload.value.eventData.enableSSL | BOOLEAN | Indicates whether SSL is enabled for the device's service information. |
payload.value.eventData.expiry | NUMBER | Indicates the expiration value for device service information. |
payload.value.eventData.extension | STRING | Contains additional event data as a string for device information service events. |
payload.value.eventData.failureReason | STRING | Indicates the reason for device firmware update failure. |
payload.value.eventData.globalServer | STRING | Specifies the global server configuration for device information service events. |
payload.value.eventData.lineId | STRING | Identifies the line identifier for device service information events. |
payload.value.eventData.lineType | STRING | Identifies the type of phone line used for the call connection or service. |
payload.value.eventData.outboundProxy | STRING | Specifies the outbound proxy server address for SIP communications. |
payload.value.eventData.outboundProxyTransport | STRING | Specifies the transport protocol used by the outbound proxy. |
payload.value.eventData.regType | STRING | Identifies the registration type of a device in various service information events. |
payload.value.eventData.serverAddr | STRING | Specifies the server address for various device-related events and communications. |
payload.value.eventData.serverPort | STRING | Identifies the server port used by the device for communication. |
payload.value.eventData.sipAccountName | STRING | Identifies the SIP account name associated with a device. |
payload.value.eventData.sipAddr | STRING | Contains the SIP address associated with a device or service. |
payload.value.eventData.sipDomainName | STRING | Identifies the domain name associated with a session initiation protocol event. |
payload.value.eventData.sipPort | NUMBER | Indicates the SIP port number used by the device. |
payload.value.eventData.sipTranport | STRING | Specifies the transport protocol used for SIP communications. |
payload.value.eventData.sipUsername | STRING | Identifies the SIP username associated with a device's service information. |
payload.value.eventData.srvPlatform | STRING | Identifies the server platform associated with a device's service information. |
payload.value.eventData.status | STRING | Indicates the status of a device or service in various operational states. |
payload.value.eventData.userId | STRING | Identifies the user associated with a particular device or service event. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DeviceInfo.ztpInfo
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.value.eventData.m_type | STRING | Identifies the type of device event data being reported in various device-related events. |
payload.value.eventData.oobSucceeded | BOOLEAN | Indicates whether out-of-band authentication was successful for device operations. |
payload.value.eventData.ztpEnabledApps | STRING[] | Lists enabled applications for zero-touch provisioning on devices. |
payload.value.eventData.ztpPersonaState | STRING | Indicates the current state of the zero-touch provisioning process for a device. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DO_REBOOT
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.error | STRING | Indicates the error message for various device operation failures. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
payload.success | BOOLEAN | Indicates whether the requested operation was successful or not. |
status.code | NUMBER | Indicates the status code of device operations and responses. |
status.error | STRING | Indicates the error status of a device or connection attempt. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DO_RESET
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.error | STRING | Indicates the error message for various device operation failures. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
payload.success | BOOLEAN | Indicates whether the requested operation was successful or not. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
DO_SYNC
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
status.code | NUMBER | Indicates the status code of device operations and responses. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
END_REMOTE_SESSION
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.errorCode | NUMBER | Indicates the error code for various session and permission related events. |
payload.message | STRING | Describes the reason for the remote session termination. |
payload.sessionId | STRING | Identifies a unique session for remote events and permission checks. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
GET_OOB_PARAMS
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
GET_PIN
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
GET_REMOTE_SESSION_STATUS
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.sessions | OBJECT[] | See payload.sessions[] definition |
payload.state | STRING | Indicates the current state of a remote session. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
GET_REMOTE_SESSION_STATUS: payload.sessions[]
Field Name | Data Type | Description |
---|---|---|
sessionId | STRING | Identifies a unique session in remote session status requests. |
GRAPHQL
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.query | STRING | Contains the query string for GraphQL requests. |
payload.token | STRING | Contains authentication token for GraphQL requests. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
HTTP_API
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.body.activePersona | STRING | Identifies the active persona associated with an HTTP API event. |
payload.body.app | STRING | Identifies the application associated with the HTTP API request payload. |
payload.body.appLocked | BOOLEAN | Indicates whether the application is currently locked or not. |
payload.body.appPersona | STRING | Identifies the application persona associated with the HTTP API event. |
payload.body.ecoMode | BOOLEAN | Indicates whether the device is operating in eco mode. |
payload.body.foregroundPersona | STRING | Identifies the foreground persona in HTTP API events for various applications. |
payload.body.id | STRING | Identifies a unique identifier for the payload body in API requests. |
payload.body.mode | STRING | Specifies the operating mode for API requests and responses. |
payload.body.polyCallControl | BOOLEAN | Indicates whether polycom call control is enabled or disabled in the HTTP API event. |
payload.body.rebootNeeded | BOOLEAN | Indicates whether a device reboot is required after an API request. |
payload.body.result | BOOLEAN | Indicates whether the HTTP API request was successful. |
payload.body.state | STRING | Indicates the current state of a resource or entity in an HTTP API request. |
payload.body.status | NUMBER | Indicates the HTTP status code returned by the API. |
payload.body.title | STRING | Contains the title of an HTTP API response body. |
payload.body.type | STRING | Identifies the type of HTTP response payload body. |
payload.body.vars | OBJECT[] | See payload.body.vars[] definition |
payload.body | OBJECT[] | See payload.body[] definition |
payload.contentType | STRING | Specifies the format of the payload in HTTP API requests. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.headers | STRING | Contains HTTP response headers with metadata such as date and content type. |
payload.responseCode | NUMBER | Indicates the HTTP response code for API transactions. |
status.error | STRING | Indicates the error status of a device or connection attempt. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
HTTP_API: payload.body.vars[]
Field Name | Data Type | Description |
---|---|---|
errorParams | STRING | Contains error details for API requests. |
isEditable | BOOLEAN | Indicates whether a variable is editable in the HTTP API event. |
isHidden | BOOLEAN | Indicates whether a variable is hidden in the HTTP API payload. |
isSecure | BOOLEAN | Indicates whether a variable is transmitted securely over the network. |
name | STRING | Identifies variable names in HTTP API payload body. |
options | STRING | Stores optional parameters for HTTP API requests. |
options | STRING[] | Stores optional values for HTTP API requests and responses. |
requestedValue | STRING | Specifies the requested value in various meeting and room reservation scenarios. |
result | STRING | Indicates the result of an HTTP API operation with a specific status code. |
value | STRING | Contains a string value representing various location names or identifiers. |
HTTP_API: payload.body[]
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application name in HTTP API event payloads. |
appPackageName | STRING | Identifies the package name of applications in HTTP API events. |
appSize | NUMBER | Represents the size of an application in bytes. |
callOnHold | BOOLEAN | Indicates whether a call is currently on hold during an API interaction. |
capabilities.canAcquireChair | BOOLEAN | Indicates whether a device can acquire a chair capability. |
capabilities.canAcquireFloor | BOOLEAN | Indicates whether a device can acquire the floor in a communication session. |
capabilities.canAddTerminal | BOOLEAN | Indicates whether a terminal can be added to a device or system. |
capabilities.canAddVideo | BOOLEAN | Indicates whether video addition is supported in the request payload. |
capabilities.canBlastDial | BOOLEAN | Indicates whether blast dialing is supported in the current session. |
capabilities.canEscalateCall | BOOLEAN | Indicates whether a call can be escalated to a higher level of support. |
capabilities.canGetRoster | BOOLEAN | Indicates whether the device can retrieve a roster of contacts or not. |
capabilities.canHangupConference | BOOLEAN | Indicates whether a conference can be hung up. |
capabilities.canHoldConf | BOOLEAN | Indicates whether a device can hold conference calls. |
capabilities.canJoinCCCP | BOOLEAN | Indicates whether a device can join a common control and command protocol. |
capabilities.canJoinChairControlConf | BOOLEAN | Indicates whether a user can join a chair control conference. |
capabilities.canJoinInternalConf | BOOLEAN | Indicates whether a user can join internal conferences. |
capabilities.canJoinMRC | BOOLEAN | Indicates whether a user can join a multi-party conference. |
capabilities.canLeaveConference | BOOLEAN | Indicates whether a user can leave a conference. |
capabilities.canMuteConference | BOOLEAN | Indicates whether a conference can be muted. |
capabilities.canMuteTerminal | BOOLEAN | Indicates whether the terminal can be muted. |
capabilities.cannotJoinConf | BOOLEAN | Indicates whether a user is unable to join a conference. |
capabilities.canPresent | BOOLEAN | Indicates whether a device can present certain capabilities. |
capabilities.canRemoveTerminal | BOOLEAN | Indicates whether a terminal can be removed from the system. |
capabilities.canShowCloseWide | BOOLEAN | Indicates whether a close button is displayed for wide screens. |
capabilities.canSupportSecurityClassification | BOOLEAN | Indicates whether security classification is supported by the device or system. |
connections | OBJECT[] | See payload.body[].connections[] definition |
connectionType | STRING | Indicates the type of connection used for the HTTP API request. |
deviceCategory | STRING | Identifies the category of device associated with the event payload. |
deviceState | STRING | Indicates the current state of a device in various network interactions. |
deviceType | STRING | Identifies the type of device in HTTP API requests. |
duration | NUMBER | Represents the length of time an operation or event took to complete in seconds. |
ecoMode | BOOLEAN | Indicates whether the device is operating in eco mode. |
holdStartTime | NUMBER | Specifies the start time of a hold period in seconds. |
holdState | STRING | Indicates whether a resource is currently being held or not. |
humanReadableVersion | STRING | Contains the human-readable version of the payload body in HTTP API events. |
id | STRING | Identifies a unique identifier for items in the payload body. |
incomingCall | BOOLEAN | Indicates whether an incoming call is present in the payload. |
inLocalPresentation | BOOLEAN | Indicates whether the payload body is in local presentation format. |
inLocalWhiteboard | BOOLEAN | Indicates whether the payload body is in a local whiteboard or not. |
inMeeting | BOOLEAN | Indicates whether a user is currently in a meeting or not. |
inPhoneCall | BOOLEAN | Indicates whether the user is currently engaged in a phone call. |
ip | STRING | Specifies the IP address associated with the request. |
isActive | BOOLEAN | Indicates whether a specific entity is currently active or not. |
isHolding | BOOLEAN | Indicates whether a resource is being held in a request. |
isMute | BOOLEAN | Indicates whether the payload body item is muted or not. |
isSvcConference | BOOLEAN | Indicates whether a service conference is in progress for the current API request. |
isWaitingInLobby | BOOLEAN | Indicates whether a user is waiting in a lobby during an API interaction. |
langtag | STRING | Identifies the language tag for specific API request payload elements. |
lastUpdatedOn | NUMBER | Stores the timestamp of the last update in milliseconds since epoch. |
macAddress | STRING | Identifies the media access control address of a device in a network transaction. |
mediaServerControlEvent | STRING | Indicates the type of media server control event that occurred. |
mediaServerType | STRING | Identifies the type of media server used in the API transaction. |
modUid | STRING | Identifies a unique modification user identifier in API requests. |
name | STRING | Identifies the name of a specific system status or provisioning parameter in API requests. |
networkInterface | STRING | Identifies the network interface used for the HTTP API request. |
outgoingCall | BOOLEAN | Indicates whether the call is outgoing in API requests. |
packageName | STRING | Identifies the package name of various applications in HTTP API events. |
personaName | STRING | Identifies the persona or entity associated with the API request payload. |
polyCallControl | BOOLEAN | Indicates whether poly call control is enabled or disabled in the request. |
productName | STRING | Identifies the product name in HTTP API payload data. |
serialNumber | STRING | Identifies the serial number of a device in API requests. |
sessionExtraInfo.dialledAddress | STRING | Identifies the dialled address in a session for HTTP API events. |
sessionExtraInfo.server | STRING | Identifies the server used in the HTTP API session. |
sessionExtraInfo.serverType | STRING | Identifies the type of server used in the session extra information. |
sessionExtraInfo.sessionID | STRING | Identifies a unique session for HTTP API transactions and events. |
sessionExtraInfo.systemName | STRING | Identifies the system name associated with a session or meeting event. |
sessionExtraInfo.systemUri | STRING | Identifies the system uniform resource identifier for various session interactions. |
softwareKeyRequired | BOOLEAN | Indicates whether a software key is required for the request. |
softwareVersion | STRING | Indicates the software version of a device or application. |
startTime | NUMBER | Represents the start time of a specific event or transaction in milliseconds. |
stateList | STRING[] | Indicates the state of a device or system component as up, down, or unknown. |
supportCertMgmt | BOOLEAN | Indicates whether certificate management is supported in the request. |
systemName | STRING | Identifies the system name in the payload body for various events and systems. |
terminals | OBJECT[] | See payload.body[].terminals[] definition |
uid | STRING | Identifies a unique user identifier in API request payloads. |
url | STRING | Specifies the URL of a requested resource in an HTTP API transaction. |
usbPrompt | BOOLEAN | Indicates whether a USB prompt is required for the HTTP API event. |
version | STRING | Specifies the version of the payload body in HTTP API events. |
versionCheckFailure | STRING | Indicates the result of a version check during an HTTP API request. |
versionCheckResult | STRING | Indicates the result of a version check operation with various possible outcomes. |
versionInfo | STRING | Contains version information for various software or firmware components. |
videoMuted | BOOLEAN | Indicates whether the video stream is muted in the payload. |
HTTP_API: payload.body[].connections[]
Field Name | Data Type | Description |
---|---|---|
address | STRING | Identifies the address of a connection in a payload body. |
answerable | BOOLEAN | Indicates whether a connection is answerable or not in API responses. |
authState | STRING | Indicates the authentication state of a connection in an HTTP API event. |
callInfo | STRING | Identifies the protocol used for a specific call in the HTTP API event. |
callType | STRING | Identifies the protocol used for a specific call in the HTTP API event. |
canAddVideo | BOOLEAN | Indicates whether video can be added to a connection. |
causeCode | NUMBER | Indicates the reason for a connection termination or failure. |
duration | NUMBER | Represents the duration of a connection in seconds. |
encrypted | BOOLEAN | Indicates whether the connection uses encryption. |
groupname | STRING | Identifies the group name associated with a connection in an HTTP API event. |
grouptype | STRING | Indicates the group type of a connection in an HTTP API event payload. |
id | STRING | Identifies a unique connection identifier in API requests. |
incoming | BOOLEAN | Indicates whether an incoming connection is established for the API request. |
mediaCount | NUMBER | Indicates the number of media items in a connection. |
mediaType | STRING | Indicates the type of media used in a connection. |
parentConfId | STRING | Identifies the parent conference identifier for a connection in an HTTP API event. |
percentConnected | NUMBER | Represents the percentage of successful connections in a given payload. |
rate | NUMBER | Specifies the data transfer rate in bits per second for network connections. |
referredBy | STRING | Identifies the referrer of a connection in API requests. |
startTime | NUMBER | Represents the start time of a connection in milliseconds since epoch. |
state | STRING | Indicates the current state of a network connection. |
terminals | OBJECT[] | See payload.body[].connections[].terminals[] definition |
type | STRING | Identifies the connection type for API requests and responses. |
videoEscalationState | STRING | Indicates the video escalation state of a connection in an HTTP API event. |
HTTP_API: payload.body[].connections[].terminals[]
Field Name | Data Type | Description |
---|---|---|
href | STRING | Identifies the hyperlink reference to a specific terminal in a conference. |
rel | STRING | Specifies the relationship of a terminal in a connection. |
HTTP_API: payload.body[].terminals[]
Field Name | Data Type | Description |
---|---|---|
address | STRING | Specifies the address of a terminal in a communication session. |
callerID | STRING | Identifies the caller's ID in various formats, including IP addresses and usernames. |
canSupportMediaStatus | BOOLEAN | Indicates whether a terminal can support media status. |
fullDescription | BOOLEAN | Indicates whether a terminal has a detailed description in HTTP API events. |
holdState | STRING | Indicates the hold status of a terminal in an HTTP API request. |
id | STRING | Identifies a unique terminal identifier in API requests. |
mediaServerType | STRING | Identifies the type of media server used in the HTTP API event. |
muted | BOOLEAN | Indicates whether a terminal is muted or not in the payload. |
muteLocked | BOOLEAN | Indicates whether the terminal's mute state is locked or not. |
name | STRING | Identifies the name of a terminal in a payload body. |
parentConfId | STRING | Identifies the parent conference identifier for a terminal in an HTTP API event. |
parentConnectionId | STRING | Identifies the parent connection identifier for a terminal in an HTTP API event. |
streamsState | STRING | Indicates the state of video streams for terminal devices. |
systemID | STRING | Identifies the system ID of various conferencing and communication platforms. |
termType | STRING | Identifies the type of terminal in a network communication transaction. |
IMPORT
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.result | STRING | Contains the result of processing a request, including any errors or version information. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
INIT
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.accountCode | STRING | Identifies the account code associated with the payload. |
payload.caCertFolder | STRING | Specifies the directory path for certificate authority certificates. |
payload.caCertPath | STRING | Specifies the file path to the certificate authority certificate. |
payload.cookieStorage | STRING | Stores the file path of cookie storage for device initialization. |
payload.deviceCertKeyPath | STRING | Specifies the file path to the device's certificate private key. |
payload.deviceCertPath | STRING | Specifies the file path of the device's certificate for secure communication. |
payload.deviceId | STRING | Identifies the device with a unique string identifier. |
payload.deviceName | STRING | Identifies the name of the device sending the message. |
payload.deviceSignature | STRING | Identifies the device signature for initialization events. |
payload.globalDirectoryUrl | STRING | Specifies the URL of the global directory for device initialization. |
payload.hardwareModel | STRING | Identifies the hardware model of the device in initialization events. |
payload.hardwarePN | STRING | Identifies the hardware part number of a device. |
payload.hardwareRevision | STRING | Identifies the hardware revision of the device during initialization. |
payload.http_server_exclusive | BOOLEAN | Indicates whether the HTTP server is exclusive to the device. |
payload.http_server_url | STRING | Specifies the URL of the HTTP server for initialization purposes. |
payload.loglevel | NUMBER | STRING | Indicates the logging level for initialization events. |
payload.m_type | STRING | Identifies the type of message payload in various device and activity events. |
payload.macAddress | STRING | Identifies the media access control address of a device. |
payload.manufacturer | STRING | Identifies the device manufacturer in various system events. |
payload.NAME | STRING | Identifies the name of a specific action or state in various device and activity events. |
payload.offsetGMT | STRING | Represents the timezone offset from Greenwich Mean Time. |
payload.orgid | STRING | Identifies the organization associated with the event. |
payload.pkey_id | STRING | Identifies a unique key for keystore engine grant operations. |
payload.powerSource | STRING | Indicates the device's current power source type. |
payload.productFamily | STRING | Identifies the product family of a device during initialization. |
payload.proxy | STRING | Specifies the proxy server used for the connection. |
payload.proxyAgent | STRING | Identifies the proxy agent used in the initialization process. |
payload.proxyAgentId | STRING | Identifies the proxy agent for the INIT event. |
payload.proxyAgentVersion | STRING | Stores the version of the proxy agent in the INIT event. |
payload.proxyname | STRING | Identifies the proxy server name in initialization events. |
payload.proxyName | STRING | Identifies the proxy service name used during initialization events. |
payload.proxypassword | STRING | Stores the proxy password for initialization events. |
payload.proxyPassword | STRING | Stores the password used for proxy authentication during initialization. |
payload.roomid | STRING | Identifies the room where an event or action takes place. |
payload.serialNumber | STRING | Identifies the device's unique serial number in initialization events. |
payload.siteid | STRING | Identifies the site location for various operational and administrative purposes. |
payload.softwareBuild | STRING | Identifies the software build version during initialization events. |
payload.softwareRelease | STRING | Specifies the software release version of the device. |
payload.updaterVersion | STRING | Indicates the version of the updater component in the system. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Labs.Lease.Request
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.feature | STRING | Identifies a specific feature in labs lease request events. |
payload.session | STRING | Identifies a unique session for various system events and requests. |
payload.timestamp | STRING | Represents the timestamp when the event payload was generated or recorded. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Labs.State.Report
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.enrolled | BOOLEAN | Indicates whether a device or user is enrolled in a particular program or service. |
payload.features | OBJECT[] | See payload.features[] definition |
payload.session | STRING | Identifies a unique session for various system events and requests. |
payload.timestamp | STRING | Represents the timestamp when the event payload was generated or recorded. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
Labs.State.Report: payload.features[]
Field Name | Data Type | Description |
---|---|---|
activated | BOOLEAN | Indicates whether a specific feature is currently activated or not. |
available | BOOLEAN | Indicates whether a specific feature is available in the report. |
id | STRING | Identifies a unique feature in labs state report events. |
params.acousticfenceradius | STRING | Specifies the acoustic fence radius for device location tracking purposes. |
params.enableacousticfence | STRING | Indicates whether the acoustic fence feature is enabled or disabled. |
params.noiseblockaioptions | STRING | Specifies the noise block AI options for audio processing. |
Labs.Telemetry.labs_clxti8l6i000108l2en4ndztv
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.feature | STRING | Identifies a specific feature in telemetry event data. |
payload.value.eventData.session | STRING | Identifies a unique session with a randomly generated identifier string. |
payload.value.eventData.telemetry.background | NUMBER | Represents a numeric telemetry value collected in the background. |
payload.value.eventData.telemetry.overall | NUMBER | Represents the overall telemetry value as a numeric measurement. |
payload.value.eventData.telemetry.voice | NUMBER | Represents the voice telemetry value as a numeric measurement. |
payload.value.eventData.type | STRING | Identifies the type of event data in telemetry messages. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
ni
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.802.1xStatus | STRING | Indicates the status of 802.1x authentication. |
payload.data.cdpStatus | STRING | Indicates the current status of the device's CDP configuration. |
payload.data.connectionMode | STRING | Indicates the mode of connection for network interface events. |
payload.data.connectionSpeed | STRING | Indicates the speed of the network connection or its current status. |
payload.data.connectionType | STRING | Indicates the type of connection used for data transmission. |
payload.data.dnsAlternativeAddress | STRING | Specifies an alternative DNS address for the device or network connection. |
payload.data.dnsDomain | STRING | Identifies the domain name associated with a network interaction. |
payload.data.dnsPrimaryAddress | STRING | Specifies the primary DNS server address for network interface events. |
payload.data.eapError | STRING | Indicates the error message for EAP authentication failures. |
payload.data.eapErrorCount | STRING | Indicates the number of EAP errors encountered during network authentication. |
payload.data.eapMethod | STRING | Identifies the authentication method used in network interactions. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.interfaceName | STRING | Identifies the network interface associated with the event. |
payload.data.ipv4Address | STRING | Specifies the IPv4 address of a device in network events. |
payload.data.ipv4AddressSource | STRING | Specifies the source of the IPv4 address for network interface events. |
payload.data.ipv4Gateway | STRING | Specifies the IPv4 gateway address for network interface events. |
payload.data.ipv4Subnet | STRING | Specifies the IPv4 subnet address for network interface events. |
payload.data.ipv6AddressSource | STRING | Specifies the source of the IPv6 address configuration. |
payload.data.ipv6GlobalAddress | STRING | Contains the IPv6 global address of a device in network interface events. |
payload.data.ipv6LinkLocalAddress | STRING | Specifies the IPv6 link local address of a network interface. |
payload.data.ipv6ULA | STRING | Contains the IPv6 Unique Local Address for network interface events. |
payload.data.lldpLocationInformation | STRING | Stores location information for network devices in a human-readable format. |
payload.data.lldpNeighbors | STRING | Stores neighboring device identifiers for network discovery events. |
payload.data.lldpStatus | STRING | Indicates the current status of the Link Layer Discovery Protocol. |
payload.data.micErrorCount | STRING | Indicates the number of microphone errors encountered during device operation. |
payload.data.ntpServer | STRING | Specifies the NTP server used for time synchronization purposes. |
payload.data.pcPortStatus | STRING | Indicates the current status of a network port connection. |
payload.data.provisioningProtocol | STRING | Specifies the protocol used for device provisioning and configuration. |
payload.data.regulatoryDomain | STRING | Identifies the regulatory domain of a device or network. |
payload.data.rssi | NUMBER | Indicates the received signal strength in wireless communication events. |
payload.data.signalStrength | STRING | Indicates the quality of the signal being received or transmitted. |
payload.data.ssid | STRING | Identifies the wireless network name associated with a device. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.data.VLAN | STRING | Identifies the virtual local area network associated with a network event. |
payload.data.wifiChannel | STRING | Indicates the WiFi channel used for network communication. |
payload.data.wifiStatus | STRING | Indicates the current wifi connection status of a device. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
pdi
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.featureVariation | STRING | Identifies the variation of a specific feature in the payload data. |
payload.data.hardwareModel | STRING | Identifies the hardware model of a device in various events. |
payload.data.hardwarePN | STRING | Identifies the hardware part number of a device. |
payload.data.hardwareRevision | STRING | Identifies the hardware revision of a device in various events. |
payload.data.macAddress | STRING | Identifies the device's media access control address in various network events. |
payload.data.manufacturer | STRING | Identifies the device manufacturer in various IoT events and messages. |
payload.data.offsetGMT | STRING | Specifies the timezone offset from Coordinated Universal Time. |
payload.data.pcsAccountCode | STRING | Identifies a unique account code for various cloud services and applications. |
payload.data.powerSource | STRING | Indicates the device's current power source type. |
payload.data.productFamily | STRING | Identifies the product family of a device in various events. |
payload.data.rebootType | STRING | Indicates the type of device reboot that occurred. |
payload.data.regionCode | STRING | Identifies the geographic region associated with the event data. |
payload.data.selfNote | STRING | Contains a self-note string for various event types and data processing purposes. |
payload.data.serialNumber | STRING | Identifies a device by its unique serial number. |
payload.data.softwareRelease | STRING | Identifies the software release version of the device. |
payload.data.updaterVersion | STRING | Specifies the version of the updater used in the event. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.data.wifiMacAddress | STRING | Identifies the wifi device's mac address in various network events. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
properties.tenantUUID | STRING | Identifies the tenant associated with a particular event or transaction. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
PERMISSION_DENIED
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.error | STRING | Indicates the error message for various device operation failures. |
payload.errorCode | NUMBER | Indicates the error code for various session and permission related events. |
payload.sessionId | STRING | Identifies a unique session for remote events and permission checks. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
push-device-policy-capabilities
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.deviceId | STRING | Identifies the device with a unique string identifier. |
payload.productId | STRING | Identifies the product associated with a device policy capabilities push event. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
REMOTE_SESSION_ICE_CANDIDATE
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.candidate | STRING | Contains ICE candidate information for remote session establishment. |
payload.sdpMid | STRING | Identifies the SDP media stream for ICE candidate messages. |
payload.sdpMLineIndex | NUMBER | Identifies the index of the SDP media line for ICE candidate messages. |
payload.sessionId | STRING | Identifies a unique session for remote events and permission checks. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
SCREENCAPTURE
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.blobName | STRING | Identifies the name of the blob containing the screen capture image. |
payload.containerName | STRING | Identifies the container name for storing device upload data. |
payload.correlationId | STRING | Identifies a unique correlation identifier for screen capture events. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.hostName | STRING | Identifies the hostname of the server hosting the payload. |
payload.sasToken | STRING | Contains a shared access signature token for secure resource access. |
payload.statusCode | NUMBER | Indicates the status code of the screen capture operation. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
sdi
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.attachedDevices | OBJECT[] | See payload.data.attachedDevices[] definition |
payload.data.attachmentState | BOOLEAN | STRING | Indicates the state of an attachment in a message or event. |
payload.data.connectionType | STRING | Indicates the type of connection used for data transmission. |
payload.data.displayName | STRING | Identifies a device or entity by its unique display name. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.macAddress | STRING | Identifies the device's media access control address in various network events. |
payload.data.pcPortMode | STRING | Indicates the port mode of the network connection. |
payload.data.pcPortSpeed | STRING | Indicates the speed of the PC port in megabits per second. |
payload.data.pcPortStatus | STRING | Indicates the current status of a network port connection. |
payload.data.peripheralType | STRING | Identifies the type of peripheral device connected to the system. |
payload.data.powerSource | STRING | Indicates the device's current power source type. |
payload.data.serialNumber | STRING | Identifies a device by its unique serial number. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
sdi: payload.data.attachedDevices[]
Field Name | Data Type | Description |
---|---|---|
attachmentState | BOOLEAN | STRING | Indicates the state of device attachment as a boolean or numeric string value. |
bluetoothAddress | STRING | Identifies the Bluetooth address of an attached device. |
connectedDevices | STRING | Contains information about connected devices and their components. |
connectionType | STRING | Indicates the connection method used by attached devices. |
displayName | STRING | Identifies the display name of attached devices in various events. |
eventMonotonicTime | STRING | Represents the event time in a monotonic format as a string value. |
macAddress | STRING | Identifies the media access control address of attached devices. |
pcPortMode | STRING | Indicates the port mode of attached devices. |
pcPortSpeed | STRING | Indicates the speed of the PC port for attached devices in network events. |
pcPortStatus | STRING | Indicates the status of a PC port on an attached device. |
peripheralType | STRING | Identifies the type of peripheral device attached to the system. |
powerSource | STRING | Indicates the power source of an attached device. |
serialNumber | STRING | Identifies the serial number of an attached device in an event. |
softwareVersion | STRING | Indicates the software version of attached devices in various events. |
service
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.authenticationType | STRING | Specifies the method used for authenticating a service request. |
payload.data.displayName | STRING | Identifies a device or entity by its unique display name. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.expiry | STRING | Specifies the expiration value associated with a service event. |
payload.data.failureReason | STRING | Specifies the reason for a service request failure. |
payload.data.lineId | STRING | Identifies the line identifier in service-related messages. |
payload.data.lineType | STRING | Indicates whether a line is private or shared in service events. |
payload.data.outboundProxy | STRING | Specifies the outbound proxy server address for service events. |
payload.data.outboundProxyPort | STRING | Specifies the port number used for outbound proxy communications. |
payload.data.outboundProxyTransport | STRING | Specifies the transport protocol used for outbound proxy communications. |
payload.data.registeredIP | STRING | Stores the IP address where a service is registered. |
payload.data.registeredPort | STRING | Identifies the registered port used for service events. |
payload.data.regType | STRING | Identifies the registration type used for service events. |
payload.data.saExpiry | STRING | Indicates the expiry time of the service authorization in seconds. |
payload.data.serverAddr | STRING | Specifies the server address for communication and connection purposes. |
payload.data.sipAddr | STRING | Contains the SIP address associated with a service event. |
payload.data.sipPort | STRING | Specifies the port number used for Session Initiation Protocol communication. |
payload.data.sipRegistrationType | STRING | Specifies the method used for SIP registration. |
payload.data.SipTlsProtocol | STRING | Indicates the protocol used for secure SIP communications. |
payload.data.sipTranport | STRING | Specifies the transport protocol used for SIP communications. |
payload.data.srvPlatform | STRING | Identifies the server platform used for the service event. |
payload.data.status | STRING | Indicates the current status of a service in various states. |
payload.data.stsURI | STRING | Specifies the URI of the certificate provisioning service. |
payload.data.triedIPList | STRING | Stores a list of IP addresses that were attempted during a service event. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.userId | STRING | Identifies the user associated with the service event. |
payload.data.userInitiatedUnRegistration | STRING | Indicates whether a service unregistration was initiated by the user. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.data.wadStatus | STRING | Indicates the status of the wide area discovery process. |
payload.ext | STRING | Contains additional call detail information in JSON format. |
payload.rto | NUMBER | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
START_REMOTE_SESSION
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.answer.sdp | STRING | Contains Session Description Protocol data for establishing communication sessions. |
payload.answer.type | STRING | Indicates the type of answer in remote session start events. |
payload.dataChannels | OBJECT[] | See payload.dataChannels[] definition |
payload.sessionId | STRING | Identifies a unique session for remote events and permission checks. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
START_REMOTE_SESSION: payload.dataChannels[]
Field Name | Data Type | Description |
---|---|---|
id | NUMBER | Identifies a unique data channel identifier for remote sessions. |
protocol | STRING | Specifies the communication protocol used for remote session data channels. |
START_UPLOAD
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
STOP_UPLOAD
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
UCSAPI
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.data.data.device.dhcp.bootSrvUseOpt.Source | STRING | Specifies the source of the DHCP boot server option. |
payload.data.data.device.dhcp.bootSrvUseOpt.Value | STRING | Indicates whether the device uses boot server options for DHCP configuration. |
payload.data.data.pcc.url.Source | STRING | Specifies the source URL of the payload data in API requests. |
payload.data.data.pcc.url.Value | STRING | Specifies the URL value for the pcc in API requests. |
payload.data.data | OBJECT[] | See payload.data.data[] definition |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.Status | STRING | Indicates the status of the API request or response. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
UCSAPI: payload.data.data[]
Field Name | Data Type | Description |
---|---|---|
Media Direction | STRING | Indicates the direction of media transmission for a call. |
Remote Connection IP | STRING | Stores the IP address of the remote connection. |
CallHandle | STRING | Identifies a unique handle for a call in various communication events. |
CallSequence | STRING | Identifies the sequence of calls in a communication session. |
CallState | STRING | Indicates the current state of a voice call in various stages of connection and disconnection. |
Channel.Label | STRING | Identifies the channel label for specific API events. |
Channel.Mode | STRING | Indicates the operating mode of a communication channel. |
Channel.Number | STRING | Identifies the channel number associated with a specific data payload. |
Channel.State | STRING | Indicates the current state of a communication channel. |
DurationSeconds | STRING | Represents the duration of an event in seconds as a string value. |
Label | STRING | Identifies a label associated with a phone number or extension in various formats. |
LineID | STRING | Identifies a specific line in a communication session. |
LineNumber | STRING | Identifies the line number associated with a specific data record. |
LineType | STRING | Indicates whether a line is private or shared in a communication system. |
Muted | STRING | Indicates whether a call or session is muted or not. |
Port | STRING | Identifies the port number used for communication in various network transactions. |
Protocol | STRING | Identifies the communication protocol used in the message payload. |
ProxyAddress | STRING | Specifies the proxy server address used in communication transactions. |
RegistrationStatus | STRING | Indicates the status of a device or user registration. |
RemotePartyName | STRING | Identifies the remote party's name or phone number in a call. |
RemotePartyNumber | STRING | Contains the remote party's phone number in various formats, including extensions. |
Ringing | STRING | Indicates whether a call is ringing or not. |
RTCPPort | STRING | Specifies the port used for Real-Time Control Protocol communication. |
RTPPort | STRING | Identifies the port used for Real-time Transport Protocol communications. |
SIPAddress | STRING | Contains the session initiation protocol address for communication events. |
StartTime | STRING | Specifies the start time of a particular event or activity in a standardized format. |
Type | STRING | Indicates the direction of a call or message in various events. |
UIAppearanceIndex | STRING | Indicates the user interface appearance index for various application states. |
UserID | STRING | Identifies the user associated with the event data. |
uianalytics
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.data.ArrowDown | STRING | Indicates the number of times the down arrow key was pressed by the user. |
payload.data.data.ArrowLeft | STRING | Represents a numeric value associated with user interface analytics events. |
payload.data.data.ArrowRight | STRING | Contains a numeric string value for user interface analytics events. |
payload.data.data.ArrowUp | STRING | Indicates the number of times the up arrow key is pressed in user interface interactions. |
payload.data.data.Back | STRING | Stores a numeric string value representing a specific user interaction or event data point. |
payload.data.data.Dialpad0 | STRING | Contains dialpad input values for user interface analytics. |
payload.data.data.Dialpad1 | STRING | Contains a numeric string value representing a dialpad input. |
payload.data.data.Dialpad2 | STRING | Contains a numeric string value representing a specific dialpad input. |
payload.data.data.Dialpad3 | STRING | Contains a numeric string value representing a dialpad input. |
payload.data.data.Dialpad4 | STRING | Contains a numeric string value representing a specific dialpad entry. |
payload.data.data.Dialpad5 | STRING | Contains a numeric string value representing a dialpad input. |
payload.data.data.Dialpad6 | STRING | Contains a numeric string representing a dialed keypad value. |
payload.data.data.Dialpad7 | STRING | Contains a numeric string value representing a dialed key. |
payload.data.data.Dialpad8 | STRING | Contains a numeric string representing a dialed number or code. |
payload.data.data.Dialpad9 | STRING | Contains a numeric string value representing a dialed key. |
payload.data.data.DialpadPound | STRING | Represents a dialpad input value in user interface analytics events. |
payload.data.data.DialpadStar | STRING | Represents a dialpad star code entered by the user. |
payload.data.data.FeatureAnonymousCallReject | STRING | Indicates whether anonymous call rejection is enabled as a feature. |
payload.data.data.FeatureApplications | STRING | Indicates the feature application identifier for analytics events. |
payload.data.data.FeatureBluetooth | STRING | Indicates the status of the Bluetooth feature in the device. |
payload.data.data.FeatureBluetoothSettings | STRING | Stores Bluetooth settings as a string value in UI analytics events. |
payload.data.data.FeatureCallTransfer | STRING | Indicates the feature code for call transfer in UI analytics events. |
payload.data.data.FeatureConference | STRING | Indicates the feature conference identifier for UI analytics events. |
payload.data.data.FeatureContactDirectory | STRING | Indicates the number of contacts in the feature contact directory. |
payload.data.data.FeatureCorporateDirectory | STRING | Indicates the corporate directory feature status as a numerical value. |
payload.data.data.FeatureDoNotDisturb | STRING | Indicates the device's Do Not Disturb feature status as a numeric string value. |
payload.data.data.FeatureEthernet | STRING | Indicates the Ethernet feature configuration for user interface analytics. |
payload.data.data.FeatureFavorites | STRING | Stores user preferences for favorite features as numeric identifiers. |
payload.data.data.FeatureForward | STRING | Indicates the feature forward status as a numeric string value. |
payload.data.data.FeatureMessages | STRING | Contains feature-related messages as numeric strings in UI analytics events. |
payload.data.data.FeatureNetworkStatistics | STRING | Contains network statistics feature data as a string value. |
payload.data.data.FeatureNewCall | STRING | Indicates the feature code for new call events in analytics data. |
payload.data.data.FeaturePhoneInfo | STRING | Stores phone feature information as a string value. |
payload.data.data.FeatureRecentCalls | STRING | Stores the number of recent calls for user interface analytics. |
payload.data.data.FeatureScreenClean | STRING | Indicates whether the feature screen is clean or not. |
payload.data.data.FeatureTCPIPParameters | STRING | Specifies the TCP/IP parameters feature configuration value as a string. |
payload.data.data.FeatureWarnings | STRING | Indicates feature warnings with numeric codes in analytics events. |
payload.data.data.FeatureWiFi | STRING | Indicates the WiFi feature status as a string value. |
payload.data.data.Handsfree | STRING | Indicates the handsfree status with various numeric codes. |
payload.data.data.Headset | STRING | Indicates the headset identifier associated with a user interaction event. |
payload.data.data.Hold | STRING | Indicates the hold status with a numeric string value. |
payload.data.data.Home | STRING | Represents a home-related data value in various analytics events. |
payload.data.data.HookDown | STRING | Indicates the hook down value as a string in various analytics events. |
payload.data.data.HookUp | STRING | Indicates the hook up data for user interface analytics events. |
payload.data.data.Line1 | STRING | Represents a line number in the user interface analytics event data. |
payload.data.data.Line10 | STRING | Stores a specific line number value as part of user interface analytics data. |
payload.data.data.Line11 | STRING | Contains a specific line number associated with user interface analytics data. |
payload.data.data.Line12 | STRING | Contains a specific line item value from the user interface analytics data. |
payload.data.data.Line13 | STRING | Stores a specific line number in the user interface analytics data. |
payload.data.data.Line14 | STRING | Contains a specific line number from the user interface analytics data. |
payload.data.data.Line2 | STRING | Represents a line number in the user interface analytics event data. |
payload.data.data.Line3 | STRING | Contains a specific line number associated with user interface analytics data. |
payload.data.data.Line4 | STRING | Contains a line number associated with user interface analytics data. |
payload.data.data.Line5 | STRING | Contains a specific line number for user interface analytics events. |
payload.data.data.Line6 | STRING | Stores a specific line number in the user interface analytics event data. |
payload.data.data.Line7 | STRING | Indicates a specific line number in the user interface analytics data. |
payload.data.data.Line8 | STRING | Contains a specific line number for user interface analytics events. |
payload.data.data.Line9 | STRING | Represents a specific line item value in the user interface analytics data. |
payload.data.data.Messages | STRING | Contains the number of messages in the payload data for analytics events. |
payload.data.data.MicMute | STRING | Indicates the microphone mute status as a numeric string value. |
payload.data.data.Select | STRING | Stores a selected data value as a string for analytics purposes. |
payload.data.data.SoftKey1 | STRING | Represents a soft key value associated with user interface interactions. |
payload.data.data.SoftKey2 | STRING | Stores a specific soft key value associated with user interface interactions. |
payload.data.data.SoftKey3 | STRING | Represents a specific soft key value associated with user interface interactions. |
payload.data.data.SoftKey4 | STRING | Represents a specific soft key identifier in user interface analytics events. |
payload.data.data.SoftKey5 | STRING | Represents a soft key press with a numeric value. |
payload.data.data.Transfer | STRING | Contains data transfer information as a string value in various events. |
payload.data.data.VolDown | STRING | Indicates the volume down event data in user interface analytics. |
payload.data.data.VolUp | STRING | Indicates the volume increase value in user interface analytics events. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
UNKNOWN
No Description
Field Name | Data Type | Description |
---|---|---|
_iothub.iothub-connection-device-id | STRING | Identifies the device connected to the IoT hub. |
_iothub.iothub-enqueuedtime | STRING | Specifies the time the message was enqueued by the IoT hub. |
datasource | STRING | Identifies the source of the data for various events and messages. |
datasourceformat | STRING | Specifies the format of the data source for various events and records. |
deviceid | STRING | Identifies a unique device identifier for various system events. |
eventdata.callstatus | STRING | Indicates the status of a call in various events. |
eventorigin | STRING | Identifies the source of an event, such as a device or system. |
eventtime | STRING | Represents the timestamp of an event in a standardized format. |
eventtype | STRING | Identifies the type of event that occurred on the device. |
eventversion | STRING | Specifies the version of the event being reported. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
mac | STRING | Identifies a device by its unique media access control address. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data | STRING | Contains various error messages and device information in string format. |
payload.status | NUMBER | Indicates the status code of various device operations and API requests. |
realip | STRING | Stores the actual IP address of the client or device making the request. |
tid | STRING | Identifies a unique transaction identifier for various system events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
unregister-device
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.deviceId | STRING | Identifies the device with a unique string identifier. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
uptime
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.data | OBJECT[] | See payload.data.data[] definition |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Definitions
uptime: payload.data.data[]
Field Name | Data Type | Description |
---|---|---|
eventMonotonicTime | STRING | Represents the event's monotonic time in hours, minutes, seconds, and milliseconds. |
status | STRING | Indicates the status of an operation with a specific error or success condition. |
timestamp | STRING | Represents the timestamp of a specific event or data point in ISO format. |
type | STRING | Identifies the type of data in the payload for various services. |
url | STRING | Specifies the URL associated with device provisioning and management activities. |
user | STRING | Identifies the user associated with the event data. |
vq
No Description
Field Name | Data Type | Description |
---|---|---|
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.data.callId | STRING | Identifies a unique call identifier for various telecommunication events. |
payload.data.eventMonotonicTime | STRING | Represents the elapsed time in hours, minutes, seconds, and milliseconds for various system events. |
payload.data.localTag | STRING | Identifies a unique local tag for various network events and records. |
payload.data.remoteTag | STRING | Identifies a unique remote tag for various network events and records. |
payload.data.report.localMetrics.burstGapLoss.bd | STRING | Represents the burst gap loss metric in bytes for voice quality events. |
payload.data.report.localMetrics.burstGapLoss.bld | STRING | Represents the burst gap loss metric in local metrics reports. |
payload.data.report.localMetrics.burstGapLoss.gd | STRING | Represents the burst gap loss metric value in the local metrics report. |
payload.data.report.localMetrics.burstGapLoss.gld | STRING | Measures the gap loss during network bursts in voice quality events. |
payload.data.report.localMetrics.burstGapLoss.gmin | STRING | Indicates the minimum burst gap loss in voice quality events. |
payload.data.report.localMetrics.delay.esd | STRING | Represents the end-to-end delay in milliseconds for voice quality events. |
payload.data.report.localMetrics.delay.iaj | STRING | Represents the inter-arrival jitter delay in local metrics reports. |
payload.data.report.localMetrics.delay.owd | STRING | Represents the one-way delay metric value as a string. |
payload.data.report.localMetrics.delay.rtd | STRING | Represents the round-trip delay in real-time metrics reports. |
payload.data.report.localMetrics.jitterBuffer.jba | STRING | Indicates the jitter buffer average value in voice quality events. |
payload.data.report.localMetrics.jitterBuffer.jbm | STRING | Represents the jitter buffer metric value in voice quality events. |
payload.data.report.localMetrics.jitterBuffer.jbn | STRING | Represents the jitter buffer size in milliseconds for voice quality events. |
payload.data.report.localMetrics.jitterBuffer.jbr | STRING | Indicates the jitter buffer size in the voice quality event report. |
payload.data.report.localMetrics.jitterBuffer.jbx | STRING | Represents the jitter buffer size in milliseconds for voice quality events. |
payload.data.report.localMetrics.packetLoss.jdr | STRING | Represents the packet loss metric as a decimal value string. |
payload.data.report.localMetrics.packetLoss.nlr | STRING | Represents the packet loss ratio as a numeric string value. |
payload.data.report.localMetrics.qualityEst.moscq | STRING | Represents the estimated mean opinion score for voice quality. |
payload.data.report.localMetrics.qualityEst.moslq | STRING | Indicates the estimated mean opinion score for voice quality. |
payload.data.report.localMetrics.qualityEst.rcq | STRING | Represents the estimated call quality as a numerical value. |
payload.data.report.localMetrics.qualityEst.rlq | STRING | Represents the estimated voice quality rating as a numerical string value. |
payload.data.report.localMetrics.sessionDesc.pps | STRING | Reports the packets per second value for a session. |
payload.data.report.localMetrics.sessionDesc.pt | STRING | Contains a numeric code describing the session description point in a voice quality event. |
payload.data.report.localMetrics.sessionDesc.ssup | STRING | Indicates the status of the SSUP feature in a session. |
payload.data.report.localMetrics.signal.rerl | STRING | Represents the received signal level in a voice quality event. |
payload.data.report.localMetrics.timeStamps.start | STRING | Represents the start time of a local metrics report in ISO format. |
payload.data.report.localMetrics.timeStamps.stop | STRING | Represents the stop timestamp in a specific metric report. |
payload.data.report.remoteMetrics.burstGapLoss.bd | STRING | Indicates the burst gap loss for remote metrics in voice quality events. |
payload.data.report.remoteMetrics.burstGapLoss.bld | STRING | Represents the burst gap loss in a voice quality event. |
payload.data.report.remoteMetrics.burstGapLoss.gd | STRING | Represents the burst gap loss metric value in remote metrics reports. |
payload.data.report.remoteMetrics.burstGapLoss.gld | STRING | Indicates the burst gap loss for remote metrics reporting in voice quality events. |
payload.data.report.remoteMetrics.burstGapLoss.gmin | STRING | Indicates the minimum burst gap loss in remote metrics reports. |
payload.data.report.remoteMetrics.delay.esd | STRING | Represents the delay in esd remote metrics as a string value. |
payload.data.report.remoteMetrics.delay.iaj | STRING | Represents the interarrival jitter delay in remote metrics reports. |
payload.data.report.remoteMetrics.delay.rtd | STRING | Represents the round-trip delay in remote metrics reports. |
payload.data.report.remoteMetrics.jitterBuffer.jba | STRING | Indicates the jitter buffer average in voice quality events. |
payload.data.report.remoteMetrics.jitterBuffer.jbm | STRING | Indicates the jitter buffer metric value in voice quality events. |
payload.data.report.remoteMetrics.jitterBuffer.jbn | STRING | Indicates the jitter buffer size in milliseconds for voice quality events. |
payload.data.report.remoteMetrics.jitterBuffer.jbr | STRING | Indicates the jitter buffer size in remote metrics reports. |
payload.data.report.remoteMetrics.jitterBuffer.jbx | STRING | Indicates the jitter buffer size in milliseconds for voice quality events. |
payload.data.report.remoteMetrics.packetLoss.jdr | STRING | Indicates the packet loss rate as a decimal value string. |
payload.data.report.remoteMetrics.packetLoss.nlr | STRING | Indicates the measured packet loss rate as a numeric string value. |
payload.data.report.remoteMetrics.qualityEst.extri | STRING | Indicates the estimated external quality metric value as a string. |
payload.data.report.remoteMetrics.qualityEst.moscq | STRING | Represents the estimated mean opinion score for voice quality. |
payload.data.report.remoteMetrics.qualityEst.moslq | STRING | Indicates the estimated mean opinion score for voice quality. |
payload.data.report.remoteMetrics.qualityEst.rcq | STRING | Represents the estimated remote connection quality as a numerical score. |
payload.data.report.remoteMetrics.sessionDesc.pps | STRING | Describes the packets per second metric in a session description report. |
payload.data.report.remoteMetrics.sessionDesc.pt | STRING | Describes the session description metric for remote video quality events. |
payload.data.report.remoteMetrics.sessionDesc.ssup | STRING | Indicates the status of the SSUP feature in a session. |
payload.data.report.remoteMetrics.signal.nl | STRING | Represents the signal strength in a network metrics report. |
payload.data.report.remoteMetrics.signal.rerl | STRING | Indicates the received signal strength in remote metrics reports. |
payload.data.report.remoteMetrics.signal.sl | STRING | Represents the signal strength level in remote metrics reports. |
payload.data.report.remoteMetrics.timeStamps.start | STRING | Represents the start time of remote metrics in ISO format. |
payload.data.report.remoteMetrics.timeStamps.stop | STRING | Represents the stop timestamp in a remote metrics report. |
payload.data.uploadTime | STRING | Represents the time data was uploaded in ISO format with timezone offset. |
payload.data.versionInfo | STRING | Indicates the version information of the device or application. |
payload.data.vqReportType | STRING | Specifies the type of voice quality report being generated. |
payload.rto | STRING | Specifies the response timeout value in various application and call events. |
payload.type | STRING | Identifies the type of payload in various events and messages. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |
Zoo.entityUpdate
No Description
Field Name | Data Type | Description |
---|---|---|
appName | STRING | Identifies the application associated with various device and system events. |
frameId | STRING | Identifies a unique frame or message identifier across various events and devices. |
name | STRING | Identifies the type of event or action being performed or reported. |
payload.attr | STRING | Contains additional attributes for various device and activity events. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.constraints.options | STRING[] | Indicates whether acoustic fence functionality is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.mutable | BOOLEAN | Indicates whether acoustic fence functionality is currently enabled or disabled. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.readable | BOOLEAN | Indicates whether the acoustic fence feature is currently enabled or disabled. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_enabled._data.value | STRING | Indicates whether acoustic fence is enabled or disabled for an entity. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.constraints.options | STRING[] | Specifies the acoustic fence sensitivity options for entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.mutable | BOOLEAN | Indicates whether acoustic fence sensitivity is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.readable | BOOLEAN | Indicates whether acoustic fence sensitivity data is readable for entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence_sensitivity._data.value | NUMBER | STRING | Specifies the acoustic fence sensitivity value for entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.constraints.options | STRING[] | Specifies the acoustic fence options for entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.mutable | BOOLEAN | Indicates whether acoustic fence data has been modified in entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.readable | BOOLEAN | Indicates whether acoustic fence data is readable for entity updates. |
payload.value.eventData.data.com.poly.audio.acoustic_fence._data.value | STRING | Represents acoustic fence data values in entity update events. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.constraints.options | STRING[] | Specifies audio noise cancellation options for entity updates. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.mutable | BOOLEAN | Indicates whether advanced active noise cancellation is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.readable | BOOLEAN | Indicates whether advanced active noise cancellation is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation_advanced._data.value | STRING | Indicates the status of advanced active noise cancellation audio feature. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.constraints.options | STRING[] | Specifies available audio noise cancellation options for entity updates. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.mutable | BOOLEAN | Indicates whether active noise cancellation is currently enabled or disabled. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.readable | BOOLEAN | Indicates whether active noise cancellation is currently enabled or disabled. |
payload.value.eventData.data.com.poly.audio.active_noise_cancellation._data.value | STRING | Indicates whether active noise cancellation is enabled for audio devices. |
payload.value.eventData.data.com.poly.audio.anc_timeout._data.constraints.options | STRING[] | Specifies audio noise cancellation timeout options as a string value. |
payload.value.eventData.data.com.poly.audio.anc_timeout._data.mutable | BOOLEAN | Indicates whether active noise cancellation has timed out for the audio device. |
payload.value.eventData.data.com.poly.audio.anc_timeout._data.readable | BOOLEAN | Indicates whether the audio anc timeout data is in a readable format. |
payload.value.eventData.data.com.poly.audio.anc_timeout._data.value | STRING | Represents the audio anc_timeout data value in entity update events. |
payload.value.eventData.data.com.poly.audio.anti_startle._data.constraints.options | STRING[] | Indicates whether the anti-startle feature is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.anti_startle._data.mutable | BOOLEAN | Indicates whether anti-startle functionality is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.anti_startle._data.readable | BOOLEAN | Indicates whether the anti-startle feature is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.anti_startle._data.value | STRING | Indicates whether the anti-startle feature is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.audio_quality._data.constraints.options | STRING[] | Specifies audio quality options for entity updates. |
payload.value.eventData.data.com.poly.audio.audio_quality._data.mutable | BOOLEAN | Indicates whether the audio quality data is mutable or not. |
payload.value.eventData.data.com.poly.audio.audio_quality._data.readable | BOOLEAN | Indicates whether audio quality data is in a readable format. |
payload.value.eventData.data.com.poly.audio.audio_quality._data.value | STRING | Represents the audio quality data in entity update events. |
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.constraints.options | STRING[] | Indicates whether auto-pause music is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.mutable | BOOLEAN | Indicates whether music is automatically paused during audio events. |
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.readable | BOOLEAN | Indicates whether music auto-pause is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.auto_pause_music._data.value | STRING | Indicates whether music should automatically pause. |
payload.value.eventData.data.com.poly.audio.bass._data.constraints.options | STRING[] | Specifies the available bass options for audio configuration. |
payload.value.eventData.data.com.poly.audio.bass._data.mutable | BOOLEAN | Indicates whether the bass audio setting is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.bass._data.readable | BOOLEAN | Indicates whether the bass audio data is in a readable format. |
payload.value.eventData.data.com.poly.audio.bass._data.value | STRING | Represents the bass audio level as a numeric string value. |
payload.value.eventData.data.com.poly.audio.extended_range._data.constraints.options | STRING[] | Indicates whether an option allows extended range audio capabilities. |
payload.value.eventData.data.com.poly.audio.extended_range._data.mutable | BOOLEAN | Indicates whether the audio range is extended for entity updates. |
payload.value.eventData.data.com.poly.audio.extended_range._data.readable | BOOLEAN | Indicates whether the audio range data is in a readable format or not. |
payload.value.eventData.data.com.poly.audio.extended_range._data.value | STRING | Indicates whether the audio range is extended or not. |
payload.value.eventData.data.com.poly.audio.g616._data.constraints.options | STRING[] | Specifies audio constraint options for entity updates. |
payload.value.eventData.data.com.poly.audio.g616._data.mutable | BOOLEAN | Indicates whether the audio data has been modified or not. |
payload.value.eventData.data.com.poly.audio.g616._data.readable | BOOLEAN | Indicates whether audio data is in a readable format or not. |
payload.value.eventData.data.com.poly.audio.g616._data.value | STRING | Indicates the current audio mode setting for the device. |
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.constraints.options | STRING[] | Specifies the daily phone usage limits in hours for audio events. |
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.mutable | BOOLEAN | Indicates whether hours on phone per day data is available for the entity. |
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.readable | BOOLEAN | Indicates whether daily phone usage hours are available in a readable format. |
payload.value.eventData.data.com.poly.audio.hours_on_phone_per_day._data.value | STRING | Represents the total hours spent on phone calls per day as a string value. |
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.constraints.options | STRING[] | Indicates whether independent volume control is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.mutable | BOOLEAN | Indicates whether independent volume control is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.readable | BOOLEAN | Indicates whether independent volume control is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.independent_volume_control._data.value | STRING | Indicates whether independent volume control is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.constraints.options | STRING[] | Specifies advanced noise block audio options for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.mutable | BOOLEAN | Indicates whether advanced noise block AI is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.readable | BOOLEAN | Indicates whether advanced noise block audio data is in a readable format. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_advanced._data.value | STRING | Stores advanced audio noise block data for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.constraints.options | STRING[] | Specifies audio noise block options for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.mutable | BOOLEAN | Indicates whether incoming audio noise block is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.readable | BOOLEAN | Indicates whether incoming audio data is readable for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_incoming._data.value | STRING | Indicates whether incoming audio noise reduction is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.constraints.options | STRING[] | Specifies audio noise reduction options for outgoing calls. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.mutable | BOOLEAN | Indicates whether the audio noise block is enabled for outgoing calls. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.readable | BOOLEAN | Indicates whether outgoing audio noise block data is readable. |
payload.value.eventData.data.com.poly.audio.noise_block_ai_outgoing._data.value | STRING | Indicates whether noise reduction is enabled for outgoing audio signals. |
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.constraints.options | STRING[] | Specifies audio noise reduction options for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.mutable | BOOLEAN | Indicates whether noise block AI data is mutable in entity update events. |
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.readable | BOOLEAN | Indicates whether audio noise block data is in a readable format. |
payload.value.eventData.data.com.poly.audio.noise_block_ai._data.value | STRING | Indicates the current audio noise reduction setting status. |
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.constraints.options | STRING[] | Specifies available noise control mode options for entity updates. |
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.mutable | BOOLEAN | Indicates whether noise control mode is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.readable | BOOLEAN | Indicates whether noise control mode is enabled or disabled for the device. |
payload.value.eventData.data.com.poly.audio.noise_control_mode._data.value | STRING | Specifies the current noise control mode of an audio device. |
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.constraints.options | STRING[] | Specifies the noise exposure limit options for audio settings. |
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.mutable | BOOLEAN | Indicates whether the noise exposure limit has been exceeded or not. |
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.readable | BOOLEAN | Indicates whether the noise exposure limit is exceeded or not in entity updates. |
payload.value.eventData.data.com.poly.audio.noise_exposure_limit._data.value | STRING | Specifies the noise exposure limit value for audio settings. |
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.constraints.options | STRING[] | Specifies the available audio volume options for a device. |
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.mutable | BOOLEAN | Indicates whether the primary audio volume is mutable or not. |
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.readable | BOOLEAN | Indicates whether the primary audio volume is readable or not. |
payload.value.eventData.data.com.poly.audio.primary_audio_volume._data.value | STRING | Represents the current primary audio volume level as a string value. |
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.constraints.options | STRING[] | Indicates whether acoustic event reporting is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.mutable | BOOLEAN | Indicates whether acoustic events are reported for entity updates. |
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.readable | BOOLEAN | Indicates whether acoustic event data is in a readable format. |
payload.value.eventData.data.com.poly.audio.report_acoustic_events._data.value | BOOLEAN | STRING | Indicates whether acoustic events are reported for entity updates. |
payload.value.eventData.data.com.poly.audio.stereo._data.constraints.options | STRING[] | Specifies audio stereo data constraints options for entity updates. |
payload.value.eventData.data.com.poly.audio.stereo._data.mutable | BOOLEAN | Indicates whether the audio is in stereo format or not. |
payload.value.eventData.data.com.poly.audio.stereo._data.readable | BOOLEAN | Indicates whether audio data is in a readable format for processing. |
payload.value.eventData.data.com.poly.audio.stereo._data.value | STRING | Contains audio data for entity updates in various IoT events. |
payload.value.eventData.data.com.poly.audio.streaming_audio._data.constraints.options | STRING[] | Specifies audio streaming options for entity updates. |
payload.value.eventData.data.com.poly.audio.streaming_audio._data.mutable | BOOLEAN | Indicates whether audio streaming is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.streaming_audio._data.readable | BOOLEAN | Indicates whether audio data is in a readable format for processing and analysis purposes. |
payload.value.eventData.data.com.poly.audio.streaming_audio._data.value | STRING | Contains audio data for entity updates in various IoT events. |
payload.value.eventData.data.com.poly.audio.tone_control._data.constraints.options | STRING[] | Specifies available tone control options for audio settings. |
payload.value.eventData.data.com.poly.audio.tone_control._data.mutable | BOOLEAN | Indicates whether tone control is enabled or disabled for audio settings. |
payload.value.eventData.data.com.poly.audio.tone_control._data.readable | BOOLEAN | Indicates whether tone control data is readable for entity updates. |
payload.value.eventData.data.com.poly.audio.tone_control._data.value | STRING | Stores audio tone control data for entity updates. |
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.constraints.options | STRING[] | Specifies audio transparency mode advanced options constraints. |
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.mutable | BOOLEAN | Indicates whether advanced audio transparency mode is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.readable | BOOLEAN | Indicates whether advanced transparency mode is enabled for audio. |
payload.value.eventData.data.com.poly.audio.transparency_mode_advanced._data.value | STRING | Indicates the transparency mode advanced audio setting for entity updates. |
payload.value.eventData.data.com.poly.audio.transparency_mode._data.constraints.options | STRING[] | Specifies audio transparency mode options for entity updates. |
payload.value.eventData.data.com.poly.audio.transparency_mode._data.mutable | BOOLEAN | Indicates whether audio transparency mode is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.transparency_mode._data.readable | BOOLEAN | Indicates whether audio transparency mode is enabled or disabled. |
payload.value.eventData.data.com.poly.audio.transparency_mode._data.value | STRING | Indicates the current audio transparency mode setting for device configuration updates. |
payload.value.eventData.data.com.poly.audio.treble._data.constraints.options | STRING[] | Specifies the available treble options for audio configuration. |
payload.value.eventData.data.com.poly.audio.treble._data.mutable | BOOLEAN | Indicates whether the treble setting is enabled or disabled for audio configurations. |
payload.value.eventData.data.com.poly.audio.treble._data.readable | BOOLEAN | Indicates whether the treble audio setting is in a readable state. |
payload.value.eventData.data.com.poly.audio.treble._data.value | STRING | Represents the treble audio setting as a numeric string value. |
payload.value.eventData.data.com.poly.audio.volume_alerts._data.constraints.options | STRING[] | Specifies the audio alert option for entity updates. |
payload.value.eventData.data.com.poly.audio.volume_alerts._data.mutable | BOOLEAN | Indicates whether audio volume alerts are enabled or disabled. |
payload.value.eventData.data.com.poly.audio.volume_alerts._data.readable | BOOLEAN | Indicates whether audio volume alerts are in a readable format. |
payload.value.eventData.data.com.poly.audio.volume_alerts._data.value | STRING | Indicates the type of audio alert triggered by the device. |
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.constraints.options | STRING[] | Specifies volume level indicator options for entity updates. |
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.mutable | BOOLEAN | Indicates whether audio volume level indicators are enabled or disabled. |
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.readable | BOOLEAN | Indicates whether audio volume level indicators are readable. |
payload.value.eventData.data.com.poly.audio.volume_level_indicators._data.value | STRING | Specifies the volume level indicator setting for audio events. |
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.constraints.options | STRING[] | Specifies audio handling options for active calls in various events. |
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.mutable | BOOLEAN | Indicates whether the active call audio is currently muted or not. |
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.readable | BOOLEAN | Indicates whether the active call audio is in a readable format. |
payload.value.eventData.data.com.poly.call_control.active_call_audio._data.value | STRING | Specifies the current audio action for an active call. |
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.constraints.options | STRING[] | Specifies whether an audio prompt is played when answering a voice call. |
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.mutable | BOOLEAN | Indicates whether a voice prompt is played when answering a call. |
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.readable | BOOLEAN | Indicates whether a voice prompt is readable during a call control event. |
payload.value.eventData.data.com.poly.call_control.answer_voice_prompt._data.value | STRING | Indicates whether a voice prompt is played when answering a call. |
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.constraints.options | STRING[] | Indicates whether an answering call alert is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.mutable | BOOLEAN | Indicates whether an incoming call is being answered or not. |
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.readable | BOOLEAN | Indicates whether an incoming call is being answered or not. |
payload.value.eventData.data.com.poly.call_control.answering_call_alert._data.value | STRING | Indicates whether an incoming call is being answered or not. |
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.constraints.options | STRING[] | Indicates whether a specific audio tone option is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.mutable | BOOLEAN | Indicates whether a tone is present on the audio channel. |
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.readable | BOOLEAN | Indicates whether the audio channel tone is in a readable format or not. |
payload.value.eventData.data.com.poly.call_control.audio_channel_tone._data.value | STRING | Indicates the presence or absence of an audio channel tone. |
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.constraints.options | STRING[] | Specifies audio prompt volume options for entity updates. |
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.mutable | BOOLEAN | Indicates whether the audio prompt volume is mutable. |
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.readable | BOOLEAN | Indicates whether the audio prompt volume is in a readable format. |
payload.value.eventData.data.com.poly.call_control.audio_prompt_volume._data.value | STRING | Specifies the audio prompt volume for call control events. |
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.constraints.options | STRING[] | Specifies audio sensing constraints options for entity updates. |
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.mutable | BOOLEAN | Indicates whether audio sensing is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.readable | BOOLEAN | Indicates whether audio sensing data is in a readable format. |
payload.value.eventData.data.com.poly.call_control.audio_sensing._data.value | STRING | Contains audio sensing data for entity updates. |
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.constraints.options | STRING[] | Indicates whether auto-answer cradle is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.mutable | BOOLEAN | Indicates whether auto answer is enabled for cradle call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.readable | BOOLEAN | Indicates whether auto answer cradle is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer_cradle._data.value | STRING | Indicates whether auto answer is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer._data.constraints.options | STRING[] | Specifies whether auto-answer is enabled or disabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer._data.mutable | BOOLEAN | Indicates whether auto-answer is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer._data.readable | BOOLEAN | Indicates whether auto-answer is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_answer._data.value | STRING | Indicates whether auto-answer is enabled or disabled for a call. |
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.constraints.options | STRING[] | Specifies constraints for auto-connecting mobile devices in certain events. |
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.mutable | BOOLEAN | Indicates whether mobile auto-connect is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.readable | BOOLEAN | Indicates whether auto connect mobile is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_connect_mobile._data.value | STRING | Indicates automatic mobile connection settings for call control events. |
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.constraints.options | STRING[] | Specifies options for automatic call disconnection when a cradle is used. |
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.mutable | BOOLEAN | Indicates whether a call is automatically disconnected when the cradle is used. |
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.readable | BOOLEAN | Indicates whether a call control feature is enabled for automatic disconnection. |
payload.value.eventData.data.com.poly.call_control.auto_disconnect_cradle._data.value | STRING | Indicates whether a call is automatically disconnected when the cradle is used. |
payload.value.eventData.data.com.poly.call_control.auto_mute._data.constraints.options | STRING[] | Specifies options for automatic mute control in certain events. |
payload.value.eventData.data.com.poly.call_control.auto_mute._data.mutable | BOOLEAN | Indicates whether automatic mute is enabled for call control. |
payload.value.eventData.data.com.poly.call_control.auto_mute._data.readable | BOOLEAN | Indicates whether auto-mute is enabled for a call. |
payload.value.eventData.data.com.poly.call_control.auto_mute._data.value | STRING | Indicates automatic mute status for call control events. |
payload.value.eventData.data.com.poly.call_control.call_announcement._data.constraints.options | STRING[] | Indicates whether a call announcement option is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.call_announcement._data.mutable | BOOLEAN | Indicates whether a call announcement is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.call_announcement._data.readable | BOOLEAN | Indicates whether call announcement data is in a readable format. |
payload.value.eventData.data.com.poly.call_control.call_announcement._data.value | STRING | Indicates whether a call announcement is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.constraints.options | STRING[] | Specifies allowed options for call button lock constraints in entity update events. |
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.mutable | BOOLEAN | Indicates whether the call control button is locked or unlocked. |
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.readable | BOOLEAN | Indicates whether the call button lock is in a readable state. |
payload.value.eventData.data.com.poly.call_control.call_button_lock._data.value | STRING | Indicates the status of call control button lock functionality. |
payload.value.eventData.data.com.poly.call_control.caller_id._data.constraints.options | STRING[] | Specifies caller identification constraints for certain entity updates. |
payload.value.eventData.data.com.poly.call_control.caller_id._data.mutable | BOOLEAN | Indicates whether the caller id is mutable in a call control event. |
payload.value.eventData.data.com.poly.call_control.caller_id._data.readable | BOOLEAN | Indicates whether the caller's identity is visible to the call recipient. |
payload.value.eventData.data.com.poly.call_control.caller_id._data.value | STRING | Indicates whether the caller id is enabled or disabled for the call. |
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.constraints.options | STRING[] | Specifies conversation limitation options as a string value. |
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.mutable | BOOLEAN | Indicates whether a conversation has reached its closure limit. |
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.readable | BOOLEAN | Indicates whether a conversation has reached its closing limit. |
payload.value.eventData.data.com.poly.call_control.close_conversation_limiting._data.value | STRING | Indicates the level of conversation limiting applied to a call. |
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.constraints.options | STRING[] | Specifies audio bandwidth constraints for computer audio options. |
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.mutable | BOOLEAN | Indicates whether computer audio bandwidth is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.readable | BOOLEAN | Indicates whether the computer audio bandwidth is readable or not. |
payload.value.eventData.data.com.poly.call_control.computer_audio_bandwidth._data.value | STRING | Specifies the computer audio bandwidth for call control events. |
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.constraints.options | STRING[] | Specifies the available ringtone sound options for computer calls. |
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.mutable | BOOLEAN | Indicates whether the computer ringtone is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.readable | BOOLEAN | Indicates whether the computer ringtone is in a readable state. |
payload.value.eventData.data.com.poly.call_control.computer_ringtone._data.value | STRING | Specifies the computer ringtone sound used for entity updates. |
payload.value.eventData.data.com.poly.call_control.computer_volume._data.constraints.options | STRING[] | Specifies the available volume control options for computer audio output. |
payload.value.eventData.data.com.poly.call_control.computer_volume._data.mutable | BOOLEAN | Indicates whether the computer volume is currently muted or not. |
payload.value.eventData.data.com.poly.call_control.computer_volume._data.readable | BOOLEAN | Indicates whether the computer volume is readable as a boolean value. |
payload.value.eventData.data.com.poly.call_control.computer_volume._data.value | STRING | Indicates the current computer volume setting as a string value. |
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.constraints.options | STRING[] | Specifies the available phone line options for call control events. |
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.mutable | BOOLEAN | Indicates whether the default phone line is enabled or disabled for call control. |
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.readable | BOOLEAN | Indicates whether the phone line is in a readable state or not. |
payload.value.eventData.data.com.poly.call_control.default_phone_line._data.value | STRING | Indicates the default phone line type used for call control operations. |
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.constraints.options | STRING[] | Indicates whether a ringtone option is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.mutable | BOOLEAN | Indicates whether a default ringtone is used for call control events. |
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.readable | BOOLEAN | Indicates whether the default ringtone is readable for the call control entity. |
payload.value.eventData.data.com.poly.call_control.default_ringtone._data.value | STRING | Indicates whether the default ringtone is enabled or disabled for call control. |
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.constraints.options | STRING[] | Specifies audio bandwidth constraints for desk phone calls. |
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.mutable | BOOLEAN | Indicates whether the desk phone audio bandwidth is mutable or not. |
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.readable | BOOLEAN | Indicates whether the audio bandwidth is readable for the desk phone. |
payload.value.eventData.data.com.poly.call_control.desk_phone_audio_bandwidth._data.value | STRING | Specifies the audio bandwidth for desk phone calls in entity update events. |
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.constraints.options | STRING[] | Specifies available options for desk phone ringtone configuration settings. |
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.mutable | BOOLEAN | Indicates whether the desk phone ringtone is currently muted or not. |
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.readable | BOOLEAN | Indicates whether the desk phone ringtone is in a readable format or not. |
payload.value.eventData.data.com.poly.call_control.desk_phone_ringtone._data.value | STRING | Specifies the desk phone ringtone data for entity updates. |
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.constraints.options | STRING[] | Specifies the available volume control options for a desk phone. |
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.mutable | BOOLEAN | Indicates whether the desk phone volume is muted or not. |
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.readable | BOOLEAN | Indicates whether the desk phone volume is in a readable state. |
payload.value.eventData.data.com.poly.call_control.desk_phone_volume._data.value | STRING | Indicates the current volume setting of a desk phone. |
payload.value.eventData.data.com.poly.call_control.dialtone._data.constraints.options | STRING[] | Indicates whether a specific option is enabled or disabled for call control. |
payload.value.eventData.data.com.poly.call_control.dialtone._data.mutable | BOOLEAN | Indicates whether a dialtone is present in a call control event. |
payload.value.eventData.data.com.poly.call_control.dialtone._data.readable | BOOLEAN | Indicates whether the dialtone data is readable or not. |
payload.value.eventData.data.com.poly.call_control.dialtone._data.value | STRING | Indicates whether a dialtone is present or not in a call control event. |
payload.value.eventData.data.com.poly.call_control.hd_voice._data.constraints.options | STRING[] | Specifies the audio bandwidth options for voice calls. |
payload.value.eventData.data.com.poly.call_control.hd_voice._data.mutable | BOOLEAN | Indicates whether high definition voice is enabled for the call. |
payload.value.eventData.data.com.poly.call_control.hd_voice._data.readable | BOOLEAN | Indicates whether the call control data is in a readable format or not. |
payload.value.eventData.data.com.poly.call_control.hd_voice._data.value | STRING | Indicates the voice quality mode used for a call. |
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.constraints.options | STRING[] | Indicates whether a hold reminder option is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.mutable | BOOLEAN | Indicates whether a call hold reminder is active or not. |
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.readable | BOOLEAN | Indicates whether a call hold reminder is active or not. |
payload.value.eventData.data.com.poly.call_control.hold_reminder._data.value | STRING | Indicates whether a call hold reminder is active or not. |
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.constraints.options | STRING[] | Specifies options for adjusting headset volume during a call. |
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.mutable | BOOLEAN | Indicates whether to increase the headset volume during a call. |
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.readable | BOOLEAN | Indicates whether the headset volume can be increased. |
payload.value.eventData.data.com.poly.call_control.increase_qd_headset_volume._data.value | STRING | Represents the value associated with a specific call control event. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.constraints.options | STRING[] | Specifies available ringtone options for mobile phone call control events. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.mutable | BOOLEAN | Indicates whether the mobile phone ringtone is muted or not. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.readable | BOOLEAN | Indicates whether the mobile phone ringtone data is readable. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_ringtone._data.value | STRING | Stores the mobile phone ringtone data for entity updates. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.constraints.options | STRING[] | Specifies the available volume control options for mobile phone devices. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.mutable | BOOLEAN | Indicates whether the mobile phone volume is muted or not. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.readable | BOOLEAN | Indicates whether the mobile phone volume is in a readable state. |
payload.value.eventData.data.com.poly.call_control.mobile_phone_volume._data.value | STRING | Represents the mobile phone volume setting as a string value. |
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.constraints.options | STRING[] | Specifies the available options for mobile voice commands in certain events. |
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.mutable | BOOLEAN | Indicates whether mobile voice commands are enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.readable | BOOLEAN | Indicates whether mobile voice commands data is readable or not. |
payload.value.eventData.data.com.poly.call_control.mobile_voice_commands._data.value | STRING | Indicates whether mobile voice commands are enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.constraints.options | STRING[] | Specifies the type of mute alert for call control events. |
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.mutable | BOOLEAN | Indicates whether a mute alert is active or not in a call control event. |
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.readable | BOOLEAN | Indicates whether a call control mute alert type is readable or not. |
payload.value.eventData.data.com.poly.call_control.mute_alert_type._data.value | STRING | Indicates the type of mute alert for call control events. |
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.constraints.options | STRING[] | Specifies the available audio options for call control alerts. |
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.mutable | BOOLEAN | Indicates whether call control mute alerts are enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.readable | BOOLEAN | Indicates whether call control mute alerts are enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_alerts._data.value | STRING | Indicates the type of tone or audio alert used for call control notifications. |
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.constraints.options | STRING[] | Specifies audio alert options for entity updates. |
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.mutable | BOOLEAN | Indicates whether the call control mute off alert is active or not. |
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.readable | BOOLEAN | Indicates whether the call control mute off alert is active or not. |
payload.value.eventData.data.com.poly.call_control.mute_off_alert._data.value | STRING | Indicates whether the call control mute off alert is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.constraints.options | STRING[] | Specifies the available mute reminder mode options for call control events. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.mutable | BOOLEAN | Indicates whether mute reminder mode is currently enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.readable | BOOLEAN | Indicates whether the mute reminder mode is currently enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_mode._data.value | STRING | Indicates the current mode of mute reminder for call control events. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.constraints.options | STRING[] | Specifies the available options for mute reminder timing constraints. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.mutable | BOOLEAN | Indicates whether a mute reminder timing is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.readable | BOOLEAN | Indicates whether a mute reminder timing is readable or not. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_timing._data.value | STRING | Specifies the timing for mute reminders in call control events. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.constraints.options | STRING[] | Specifies the available volume options for mute reminder notifications. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.mutable | BOOLEAN | Indicates whether the mute reminder volume is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.readable | BOOLEAN | Indicates whether the mute reminder volume is readable in certain entity update events. |
payload.value.eventData.data.com.poly.call_control.mute_reminder_volume._data.value | STRING | Indicates the volume level for mute reminders in call control events. |
payload.value.eventData.data.com.poly.call_control.notification_tones._data.constraints.options | STRING[] | Indicates whether a specific option is enabled or disabled for notification tones. |
payload.value.eventData.data.com.poly.call_control.notification_tones._data.mutable | BOOLEAN | Indicates whether notification tones are enabled for call control events. |
payload.value.eventData.data.com.poly.call_control.notification_tones._data.readable | BOOLEAN | Indicates whether notification tones are in a readable format or not. |
payload.value.eventData.data.com.poly.call_control.notification_tones._data.value | STRING | Indicates whether notification tones are enabled or disabled for call control events. |
payload.value.eventData.data.com.poly.call_control.online_indicator._data.constraints.options | STRING[] | Indicates whether an online indicator option is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.online_indicator._data.mutable | BOOLEAN | Indicates whether the call control is online or offline. |
payload.value.eventData.data.com.poly.call_control.online_indicator._data.readable | BOOLEAN | Indicates whether the call control online status is readable or not. |
payload.value.eventData.data.com.poly.call_control.online_indicator._data.value | STRING | Indicates whether the call control is online or offline. |
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.constraints.options | STRING[] | Specifies options for over-the-air subscription constraints in entity update events. |
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.mutable | BOOLEAN | Indicates whether an over-the-air subscription is mutable or not. |
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.readable | BOOLEAN | Indicates whether the call control subscription data is readable over the air. |
payload.value.eventData.data.com.poly.call_control.over_air_subscription._data.value | STRING | Contains call control data for entity updates. |
payload.value.eventData.data.com.poly.call_control.range._data.constraints.options | STRING[] | Specifies options for call control range constraints in entity update events. |
payload.value.eventData.data.com.poly.call_control.range._data.mutable | BOOLEAN | Indicates whether call control range data is mutable or not. |
payload.value.eventData.data.com.poly.call_control.range._data.readable | BOOLEAN | Indicates whether call control data is in a readable format. |
payload.value.eventData.data.com.poly.call_control.range._data.value | STRING | Contains call control range data for entity updates. |
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.constraints.options | STRING[] | Specifies options for ring vibration settings in device configurations. |
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.mutable | BOOLEAN | Indicates whether the device is set to vibrate during an incoming call. |
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.readable | BOOLEAN | Indicates whether the ring vibration setting is in a readable state. |
payload.value.eventData.data.com.poly.call_control.ring_vibration._data.value | STRING | Indicates the ring or vibration status of a call. |
payload.value.eventData.data.com.poly.call_control.rocket_button._data.constraints.options | STRING[] | Specifies options for call control actions, such as audio or playback functions. |
payload.value.eventData.data.com.poly.call_control.rocket_button._data.mutable | BOOLEAN | Indicates whether the rocket button is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.rocket_button._data.readable | BOOLEAN | Indicates whether the rocket button data is in a readable format or not. |
payload.value.eventData.data.com.poly.call_control.rocket_button._data.value | STRING | Represents the value of a specific call control event or action. |
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.constraints.options | STRING[] | Specifies the handling options for incoming calls during an active call session. |
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.mutable | BOOLEAN | Indicates whether a second incoming call is present during the event. |
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.readable | BOOLEAN | Indicates whether a second incoming call is readable or not. |
payload.value.eventData.data.com.poly.call_control.second_incoming_call._data.value | STRING | Specifies the handling behavior for a second incoming call. |
payload.value.eventData.data.com.poly.call_control.sidetone._data.constraints.options | STRING[] | Specifies the available audio constraint options for the sidetone control. |
payload.value.eventData.data.com.poly.call_control.sidetone._data.mutable | BOOLEAN | Indicates whether sidetone is enabled or disabled for call control. |
payload.value.eventData.data.com.poly.call_control.sidetone._data.readable | BOOLEAN | Indicates whether the sidetone data is readable or not. |
payload.value.eventData.data.com.poly.call_control.sidetone._data.value | STRING | Indicates the sidetone level for call control events. |
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.constraints.options | STRING[] | Specifies audio transfer options for smart call control functionality. |
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.mutable | BOOLEAN | Indicates whether smart audio transfer is enabled or disabled. |
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.readable | BOOLEAN | Indicates whether smart audio transfer data is readable or not. |
payload.value.eventData.data.com.poly.call_control.smart_audio_transfer._data.value | STRING | Contains data related to smart audio transfer in entity update events. |
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.constraints.options | STRING[] | Specifies wearable device configuration options for entity updates. |
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.mutable | BOOLEAN | Indicates whether a wearable device is being worn or not. |
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.readable | BOOLEAN | Indicates whether the wearing preference data is in a readable format. |
payload.value.eventData.data.com.poly.call_control.wearing_preference._data.value | STRING | Stores the user's wearing preference for call control events. |
payload.value.eventData.data.com.poly.device.pid._data.constraints.options | STRING[] | Specifies device configuration options as a list of string values. |
payload.value.eventData.data.com.poly.device.pid._data.mutable | BOOLEAN | Indicates whether a device's mutable data has been updated. |
payload.value.eventData.data.com.poly.device.pid._data.readable | BOOLEAN | Indicates whether device data is readable or not. |
payload.value.eventData.data.com.poly.device.pid._data.value | NUMBER | Identifies a unique device identifier for entity update events. |
payload.value.eventData.data.com.poly.device.serial_number._data.constraints.options | STRING[] | Specifies a list of possible serial number options for device configuration. |
payload.value.eventData.data.com.poly.device.serial_number._data.mutable | BOOLEAN | Indicates whether the device serial number is mutable or not. |
payload.value.eventData.data.com.poly.device.serial_number._data.readable | BOOLEAN | Indicates whether a device's serial number is readable. |
payload.value.eventData.data.com.poly.device.serial_number._data.value | STRING | Identifies a unique serial number for a device in various events. |
payload.value.eventData.data.com.poly.device.software_version._data.constraints.options | STRING[] | Specifies the available software version options for a device. |
payload.value.eventData.data.com.poly.device.software_version._data.mutable | BOOLEAN | Indicates whether the device software version data is mutable or not. |
payload.value.eventData.data.com.poly.device.software_version._data.readable | BOOLEAN | Indicates whether the device software version is in a readable format. |
payload.value.eventData.data.com.poly.device.software_version._data.value | STRING | Stores the software version of a device in various event notifications. |
payload.value.eventData.data.com.poly.general.battery_charging._data.constraints.options | STRING[] | Specifies available battery charging options for entity updates. |
payload.value.eventData.data.com.poly.general.battery_charging._data.mutable | BOOLEAN | Indicates whether the device's battery is currently being charged. |
payload.value.eventData.data.com.poly.general.battery_charging._data.readable | BOOLEAN | Indicates whether the device's battery is currently being charged. |
payload.value.eventData.data.com.poly.general.battery_charging._data.value | STRING | Indicates the device's battery charging status as a string value. |
payload.value.eventData.data.com.poly.general.battery_level._data.constraints.options | STRING[] | Specifies possible values for the battery level data field in entity update events. |
payload.value.eventData.data.com.poly.general.battery_level._data.mutable | BOOLEAN | Indicates whether the device battery level is mutable or not. |
payload.value.eventData.data.com.poly.general.battery_level._data.readable | BOOLEAN | Indicates whether the battery level is readable or not. |
payload.value.eventData.data.com.poly.general.battery_level._data.value | STRING | Represents the current battery level of a device in various entity update messages. |
payload.value.eventData.data.com.poly.general.battery_status_alert._data.constraints.options | STRING[] | Indicates whether a battery status alert option is enabled or disabled. |
payload.value.eventData.data.com.poly.general.battery_status_alert._data.mutable | BOOLEAN | Indicates whether a battery status alert is active or not. |
payload.value.eventData.data.com.poly.general.battery_status_alert._data.readable | BOOLEAN | Indicates whether a battery status alert is active or not. |
payload.value.eventData.data.com.poly.general.battery_status_alert._data.value | STRING | Indicates whether a battery status alert is triggered for a device. |
payload.value.eventData.data.com.poly.general.charge_vibration._data.constraints.options | STRING[] | Specifies available vibration options for device configuration. |
payload.value.eventData.data.com.poly.general.charge_vibration._data.mutable | BOOLEAN | Indicates whether the device is set to vibrate when charging. |
payload.value.eventData.data.com.poly.general.charge_vibration._data.readable | BOOLEAN | Indicates whether vibration charge data is readable. |
payload.value.eventData.data.com.poly.general.charge_vibration._data.value | STRING | Stores vibration charge data as a string value in entity update events. |
payload.value.eventData.data.com.poly.general.is_online._data.constraints.options | STRING[] | Specifies online status options for entity updates in various events. |
payload.value.eventData.data.com.poly.general.is_online._data.mutable | BOOLEAN | Indicates whether a device or entity is currently online or not. |
payload.value.eventData.data.com.poly.general.is_online._data.readable | BOOLEAN | Indicates whether a device or entity is currently online or not. |
payload.value.eventData.data.com.poly.general.is_online._data.value | STRING | Indicates whether a device or entity is currently online or not. |
payload.value.eventData.data.com.poly.general.language._data.constraints.options | STRING[] | Specifies language options for entity updates in various events. |
payload.value.eventData.data.com.poly.general.language._data.mutable | BOOLEAN | Indicates whether language data is mutable in entity update events. |
payload.value.eventData.data.com.poly.general.language._data.readable | BOOLEAN | Indicates whether language data is readable in entity update events. |
payload.value.eventData.data.com.poly.general.language._data.value | STRING | Stores language data for entity updates in various IoT events. |
payload.value.eventData.data.com.poly.general.restore_defaults._data.constraints.options | STRING[] | Specifies configuration options for device restore defaults operations. |
payload.value.eventData.data.com.poly.general.restore_defaults._data.mutable | BOOLEAN | Indicates whether device settings have been restored to default values. |
payload.value.eventData.data.com.poly.general.restore_defaults._data.readable | BOOLEAN | Indicates whether device settings have been restored to default values. |
payload.value.eventData.data.com.poly.general.restore_defaults._data.value | STRING | Stores data related to restoring default settings in entity update events. |
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.constraints.options | STRING[] | Specifies available options for sensor settings in entity update events. |
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.mutable | BOOLEAN | Indicates whether sensor settings are enabled or disabled. |
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.readable | BOOLEAN | Indicates whether sensor settings are enabled and readable. |
payload.value.eventData.data.com.poly.general.sensor_settings_enabled._data.value | STRING | Indicates whether sensor settings are enabled for a device or entity. |
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.constraints.options | STRING[] | Indicates whether a specific option is enabled for the entity. |
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.mutable | BOOLEAN | Indicates whether high performance computing is enabled for the entity. |
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.readable | BOOLEAN | Indicates whether the HPCC feature is enabled on the device. |
payload.value.eventData.data.com.poly.mtr.hpcc.enabled._data.value | BOOLEAN | Indicates whether high-performance computing is enabled for the entity. |
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.mutable | BOOLEAN | Indicates whether the version data is mutable or not. |
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.readable | BOOLEAN | Indicates whether the version data is in a readable format. |
payload.value.eventData.data.com.poly.mtr.hpcc.version._data.value | STRING | Stores the version number of the HPCC system in entity update events. |
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.constraints.options | STRING[] | Specifies the allowed firmware update postpone times options for software updates. |
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.mutable | BOOLEAN | Indicates whether firmware update postponement is allowed for a device. |
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.readable | BOOLEAN | Indicates whether firmware update postponement is allowed for a device. |
payload.value.eventData.data.com.poly.software_update.policy.allow_fw_update_postpone_times._data.value | NUMBER | Specifies the allowed number of firmware update postponements. |
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.constraints.options | STRING[] | Specifies the allowed times for postponing software updates. |
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.mutable | BOOLEAN | Indicates whether software updates can be postponed at a later time. |
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.readable | BOOLEAN | Indicates whether software update postponement times are allowed to be read. |
payload.value.eventData.data.com.poly.software_update.policy.allow_update_postpone_times._data.value | NUMBER | Specifies the number of times a software update can be postponed. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.constraints.options | STRING[] | Specifies the end time for automatic software updates in a 24-hour format. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.mutable | BOOLEAN | Indicates whether the software update end time is mutable. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.readable | BOOLEAN | Indicates whether the software update end time is in a readable format. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.end_time._data.value | STRING | Specifies the end time for automatic software updates in hours and minutes format. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.constraints.options | STRING[] | Specifies the timeframe interval for automatic software updates in seconds. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.mutable | BOOLEAN | Indicates whether the software update policy timeframe interval is mutable. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.readable | BOOLEAN | Indicates whether the software update policy timeframe interval is readable. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.interval._data.value | STRING | Specifies the automatic software update interval in hours, minutes, and seconds. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.constraints.options | STRING[] | Specifies the start time for automatic software updates in a 24-hour format. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.mutable | BOOLEAN | Indicates whether the software update policy start time is mutable. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.readable | BOOLEAN | Indicates whether the software update start time is in a readable format. |
payload.value.eventData.data.com.poly.software_update.policy.auto.timeframe.start_time._data.value | STRING | Specifies the start time for automatic software updates in a 24-hour format. |
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.constraints.options | STRING[] | Indicates whether software updates are disabled for a device or entity. |
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.mutable | BOOLEAN | Indicates whether software updates are disabled for a device or entity. |
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.readable | BOOLEAN | Indicates whether software updates are disabled for a device or entity. |
payload.value.eventData.data.com.poly.software_update.policy.disable_software_update._data.value | BOOLEAN | Indicates whether software updates are enabled or disabled for a device. |
payload.value.eventData.data.com.poly.video.anti_flicker._data.constraints.options | STRING[] | Specifies video anti-flicker options for entity updates. |
payload.value.eventData.data.com.poly.video.anti_flicker._data.mutable | BOOLEAN | Indicates whether anti-flicker is enabled for video settings. |
payload.value.eventData.data.com.poly.video.anti_flicker._data.readable | BOOLEAN | Indicates whether anti-flicker is enabled for video settings. |
payload.value.eventData.data.com.poly.video.anti_flicker._data.value | STRING | Indicates the anti-flicker setting value for video devices. |
payload.value.eventData.data.com.poly.video.back_light_compensation._data.constraints.options | STRING[] | Specifies the available back light compensation options for video settings. |
payload.value.eventData.data.com.poly.video.back_light_compensation._data.mutable | BOOLEAN | Indicates whether back light compensation is enabled for video capture. |
payload.value.eventData.data.com.poly.video.back_light_compensation._data.readable | BOOLEAN | Indicates whether back light compensation is enabled for video capture. |
payload.value.eventData.data.com.poly.video.back_light_compensation._data.value | STRING | Indicates whether back light compensation is enabled or disabled for video capture. |
payload.value.eventData.data.com.poly.video.brightness._data.constraints.options | STRING[] | Specifies the available brightness options for video settings. |
payload.value.eventData.data.com.poly.video.brightness._data.mutable | BOOLEAN | Indicates whether the video brightness is adjustable. |
payload.value.eventData.data.com.poly.video.brightness._data.readable | BOOLEAN | Indicates whether video brightness data is readable or not. |
payload.value.eventData.data.com.poly.video.brightness._data.value | STRING | Represents the brightness level of a video device as a string value. |
payload.value.eventData.data.com.poly.video.camera_movement._data.constraints.options | STRING[] | Specifies video camera movement options for entity updates. |
payload.value.eventData.data.com.poly.video.camera_movement._data.mutable | BOOLEAN | Indicates whether the camera has detected movement or not. |
payload.value.eventData.data.com.poly.video.camera_movement._data.readable | BOOLEAN | Indicates whether camera movement data is in a readable format. |
payload.value.eventData.data.com.poly.video.camera_movement._data.value | STRING | Indicates the type of camera movement event that occurred. |
payload.value.eventData.data.com.poly.video.contrast._data.constraints.options | STRING[] | Specifies video contrast options as binary values. |
payload.value.eventData.data.com.poly.video.contrast._data.mutable | BOOLEAN | Indicates whether the video contrast setting is mutable or not. |
payload.value.eventData.data.com.poly.video.contrast._data.readable | BOOLEAN | Indicates whether video contrast data is readable. |
payload.value.eventData.data.com.poly.video.contrast._data.value | STRING | Represents the video contrast setting as a numeric string value. |
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.constraints.options | STRING[] | Indicates whether auto exposure is enabled for video capture. |
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.mutable | BOOLEAN | Indicates whether automatic exposure is enabled for video capture. |
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.readable | BOOLEAN | Indicates whether automatic exposure is enabled for video capture. |
payload.value.eventData.data.com.poly.video.exposure_auto_enabled._data.value | BOOLEAN | STRING | Indicates whether auto exposure is enabled for video capture. |
payload.value.eventData.data.com.poly.video.exposure._data.constraints.options | STRING[] | Specifies video exposure constraint options as numeric strings. |
payload.value.eventData.data.com.poly.video.exposure._data.mutable | BOOLEAN | Indicates whether video exposure settings are mutable or not. |
payload.value.eventData.data.com.poly.video.exposure._data.readable | BOOLEAN | Indicates whether video exposure data is in a readable format. |
payload.value.eventData.data.com.poly.video.exposure._data.value | STRING | Represents the exposure value of a video in a specific entity update event. |
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.constraints.options | STRING[] | Indicates whether auto focus is enabled for video capture. |
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.mutable | BOOLEAN | Indicates whether auto focus is enabled for video functionality. |
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.readable | BOOLEAN | Indicates whether auto focus is enabled for video functionality. |
payload.value.eventData.data.com.poly.video.focus_auto_enabled._data.value | BOOLEAN | STRING | Indicates whether auto focus is enabled for video functionality. |
payload.value.eventData.data.com.poly.video.focus._data.constraints.options | STRING[] | Specifies video focus constraints options as binary values. |
payload.value.eventData.data.com.poly.video.focus._data.mutable | BOOLEAN | Indicates whether the video is in focus or not. |
payload.value.eventData.data.com.poly.video.focus._data.readable | BOOLEAN | Indicates whether video focus data is readable in entity update events. |
payload.value.eventData.data.com.poly.video.focus._data.value | STRING | Stores video focus event data as a string value. |
payload.value.eventData.data.com.poly.video.frame_size._data.constraints.options | STRING[] | Specifies video frame size constraints for entity updates. |
payload.value.eventData.data.com.poly.video.frame_size._data.mutable | BOOLEAN | Indicates whether the video frame size data is mutable or not. |
payload.value.eventData.data.com.poly.video.frame_size._data.readable | BOOLEAN | Indicates whether video frame size data is readable or not. |
payload.value.eventData.data.com.poly.video.frame_size._data.value | STRING | Specifies the video frame size for entity update events. |
payload.value.eventData.data.com.poly.video.gain._data.constraints.options | STRING[] | Specifies the available video gain options for entity updates. |
payload.value.eventData.data.com.poly.video.gain._data.mutable | BOOLEAN | Indicates whether the video gain is mutable or not in entity updates. |
payload.value.eventData.data.com.poly.video.gain._data.readable | BOOLEAN | Indicates whether video gain data is readable in entity update events. |
payload.value.eventData.data.com.poly.video.gain._data.value | STRING | Represents the video gain value in entity update events. |
payload.value.eventData.data.com.poly.video.gamma._data.constraints.options | STRING[] | Specifies the available gamma correction options for video settings. |
payload.value.eventData.data.com.poly.video.gamma._data.mutable | BOOLEAN | Indicates whether video gamma correction is enabled or disabled. |
payload.value.eventData.data.com.poly.video.gamma._data.readable | BOOLEAN | Indicates whether video gamma data is in a readable format. |
payload.value.eventData.data.com.poly.video.gamma._data.value | STRING | Represents the gamma value for video settings in entity update events. |
payload.value.eventData.data.com.poly.video.hue._data.constraints.options | STRING[] | Specifies the available options for video hue constraints in entity update events. |
payload.value.eventData.data.com.poly.video.hue._data.mutable | BOOLEAN | Indicates whether the video hue data has been modified. |
payload.value.eventData.data.com.poly.video.hue._data.readable | BOOLEAN | Indicates whether the video hue data is in a readable format or not. |
payload.value.eventData.data.com.poly.video.hue._data.value | STRING | Represents the hue value in entity update events. |
payload.value.eventData.data.com.poly.video.image_flip._data.constraints.options | STRING[] | Specifies the image flip option for video events. |
payload.value.eventData.data.com.poly.video.image_flip._data.mutable | BOOLEAN | Indicates whether video image flip is enabled or disabled. |
payload.value.eventData.data.com.poly.video.image_flip._data.readable | BOOLEAN | Indicates whether the video image is flipped for display purposes. |
payload.value.eventData.data.com.poly.video.image_flip._data.value | STRING | Indicates whether video image flip is enabled or disabled. |
payload.value.eventData.data.com.poly.video.max_zoom._data.constraints.options | STRING[] | Specifies the maximum zoom options available for video recording. |
payload.value.eventData.data.com.poly.video.max_zoom._data.mutable | BOOLEAN | Indicates whether the maximum zoom level is mutable for video settings. |
payload.value.eventData.data.com.poly.video.max_zoom._data.readable | BOOLEAN | Indicates whether the maximum zoom value is readable for video data. |
payload.value.eventData.data.com.poly.video.max_zoom._data.value | STRING | Specifies the maximum zoom level for video in entity update events. |
payload.value.eventData.data.com.poly.video.pan._data.constraints.options | STRING[] | Specifies the video pan constraints options as numerical values. |
payload.value.eventData.data.com.poly.video.pan._data.mutable | BOOLEAN | Indicates whether video pan data has been modified in the entity update event. |
payload.value.eventData.data.com.poly.video.pan._data.readable | BOOLEAN | Indicates whether video pan data is readable or not. |
payload.value.eventData.data.com.poly.video.pan._data.value | STRING | Represents the video pan value as a numeric string. |
payload.value.eventData.data.com.poly.video.participant_count._data.constraints.options | STRING[] | Indicates whether a specific video participant option is enabled or disabled. |
payload.value.eventData.data.com.poly.video.participant_count._data.mutable | BOOLEAN | Indicates whether the participant count in a video event is mutable or not. |
payload.value.eventData.data.com.poly.video.participant_count._data.readable | BOOLEAN | Indicates whether the participant count data is readable for entity updates. |
payload.value.eventData.data.com.poly.video.participant_count._data.value | STRING | Indicates whether a video participant count is available or not. |
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.constraints.options | STRING[] | Specifies the available depth options for video perimeter configuration. |
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.mutable | BOOLEAN | Indicates whether the perimeter depth data is mutable for entity updates. |
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.readable | BOOLEAN | Indicates whether the perimeter depth data is in a readable format. |
payload.value.eventData.data.com.poly.video.poly_perimeter.depth._data.value | STRING | Represents the depth value of a perimeter in a video analytics event. |
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.constraints.options | STRING[] | Indicates whether the video perimeter feature is enabled or disabled. |
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.mutable | BOOLEAN | Indicates whether the perimeter feature is enabled for a video entity. |
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.readable | BOOLEAN | Indicates whether the video perimeter is enabled or disabled. |
payload.value.eventData.data.com.poly.video.poly_perimeter.enabled._data.value | BOOLEAN | STRING | Indicates whether the video perimeter is enabled or disabled. |
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.constraints.options | STRING[] | Specifies configuration options for video perimeter events. |
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.mutable | BOOLEAN | Indicates whether the front perimeter of a Poly video device is enabled or disabled. |
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.readable | BOOLEAN | Indicates whether the front perimeter data is in a readable format or not. |
payload.value.eventData.data.com.poly.video.poly_perimeter.front._data.value | STRING | Indicates the current state of the perimeter video feature. |
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.constraints.options | STRING[] | Specifies the unit of measurement for a given metric value. |
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.mutable | BOOLEAN | Indicates whether a specific video perimeter metric is enabled or disabled. |
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.readable | BOOLEAN | Indicates whether video perimeter metric data is readable. |
payload.value.eventData.data.com.poly.video.poly_perimeter.metric._data.value | STRING | Represents a measured or calculated value in various units for entity updates. |
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.constraints.options | STRING[] | Specifies the available options for video perimeter width settings. |
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.mutable | BOOLEAN | Indicates whether the video perimeter width is mutable or not. |
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.readable | BOOLEAN | Indicates whether the video perimeter width is in a readable format. |
payload.value.eventData.data.com.poly.video.poly_perimeter.width._data.value | STRING | Specifies the width of a video perimeter in various entity update events. |
payload.value.eventData.data.com.poly.video.saturation._data.constraints.options | STRING[] | Specifies video saturation options as a list of string values. |
payload.value.eventData.data.com.poly.video.saturation._data.mutable | BOOLEAN | Indicates whether video saturation is enabled or disabled. |
payload.value.eventData.data.com.poly.video.saturation._data.readable | BOOLEAN | Indicates whether video saturation data is in a readable format. |
payload.value.eventData.data.com.poly.video.saturation._data.value | STRING | Represents the video saturation level as a numeric string value. |
payload.value.eventData.data.com.poly.video.sharpness._data.constraints.options | STRING[] | Specifies video sharpness options as binary values. |
payload.value.eventData.data.com.poly.video.sharpness._data.mutable | BOOLEAN | Indicates whether video sharpness is enabled or disabled. |
payload.value.eventData.data.com.poly.video.sharpness._data.readable | BOOLEAN | Indicates whether video sharpness data is readable. |
payload.value.eventData.data.com.poly.video.sharpness._data.value | STRING | Specifies the video sharpness level as a numeric string value. |
payload.value.eventData.data.com.poly.video.tilt._data.constraints.options | STRING[] | Specifies the available tilt angle options for video devices. |
payload.value.eventData.data.com.poly.video.tilt._data.mutable | BOOLEAN | Indicates whether the video tilt is mutable or not in entity update events. |
payload.value.eventData.data.com.poly.video.tilt._data.readable | BOOLEAN | Indicates whether video tilt data is in a readable format. |
payload.value.eventData.data.com.poly.video.tilt._data.value | STRING | Represents the tilt value of a video device in entity update events. |
payload.value.eventData.data.com.poly.video.tracking_mode._data.constraints.options | STRING[] | Specifies video tracking mode options for entity updates. |
payload.value.eventData.data.com.poly.video.tracking_mode._data.mutable | BOOLEAN | Indicates whether video tracking mode is enabled or disabled. |
payload.value.eventData.data.com.poly.video.tracking_mode._data.readable | BOOLEAN | Indicates whether video tracking mode is enabled or disabled. |
payload.value.eventData.data.com.poly.video.tracking_mode._data.value | STRING | Specifies the current video tracking mode in use. |
payload.value.eventData.data.com.poly.video.tracking_speed._data.constraints.options | STRING[] | Specifies the video tracking speed options for entity updates. |
payload.value.eventData.data.com.poly.video.tracking_speed._data.mutable | BOOLEAN | Indicates whether video tracking speed is enabled or disabled. |
payload.value.eventData.data.com.poly.video.tracking_speed._data.readable | BOOLEAN | Indicates whether video tracking speed data is in a readable format. |
payload.value.eventData.data.com.poly.video.tracking_speed._data.value | STRING | Indicates the video tracking speed setting as fast, normal, or slow. |
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.constraints.options | STRING[] | Indicates whether automatic white balance is enabled for video capture. |
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.mutable | BOOLEAN | Indicates whether automatic white balance is enabled for video capture. |
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.readable | BOOLEAN | Indicates whether automatic white balance is enabled for video capture. |
payload.value.eventData.data.com.poly.video.white_balance_auto_enabled._data.value | BOOLEAN | STRING | Indicates whether automatic white balance is enabled for video capture. |
payload.value.eventData.data.com.poly.video.white_balance._data.constraints.options | STRING[] | Specifies available white balance options in Kelvin for video settings. |
payload.value.eventData.data.com.poly.video.white_balance._data.mutable | BOOLEAN | Indicates whether video white balance is enabled or disabled. |
payload.value.eventData.data.com.poly.video.white_balance._data.readable | BOOLEAN | Indicates whether the video white balance data is readable. |
payload.value.eventData.data.com.poly.video.white_balance._data.value | STRING | Represents the white balance value in video settings as a numerical string. |
payload.value.eventData.data.com.poly.video.zoom._data.constraints.options | STRING[] | Specifies the available zoom options for video constraints in entity update events. |
payload.value.eventData.data.com.poly.video.zoom._data.mutable | BOOLEAN | Indicates whether video zoom data has been modified in the entity update event. |
payload.value.eventData.data.com.poly.video.zoom._data.readable | BOOLEAN | Indicates whether video data is readable in entity update events. |
payload.value.eventData.data.com.poly.video.zoom._data.value | STRING | Represents the video zoom level as a numeric string value. |
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.constraints.options | STRING[] | Specifies options for clearing trusted devices in entity update events. |
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.mutable | BOOLEAN | Indicates whether trusted devices should be cleared from the system configuration. |
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.readable | BOOLEAN | Indicates whether trusted devices have been cleared from the system. |
payload.value.eventData.data.com.poly.wireless.clear_trusted_devices._data.value | STRING | Contains data for clearing trusted devices in entity update events. |
payload.value.eventData.data.com.poly.wireless.connection_indication._data.constraints.options | STRING[] | Indicates whether a specific option is enabled or disabled for a connection. |
payload.value.eventData.data.com.poly.wireless.connection_indication._data.mutable | BOOLEAN | Indicates the connection status of a wireless device. |
payload.value.eventData.data.com.poly.wireless.connection_indication._data.readable | BOOLEAN | Indicates whether the connection data is in a readable format or not. |
payload.value.eventData.data.com.poly.wireless.connection_indication._data.value | STRING | Indicates the connection status of a wireless device. |
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.constraints.options | STRING[] | Specifies configuration options for maintaining wireless link connectivity. |
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.mutable | BOOLEAN | Indicates whether the link should remain active for entity updates. |
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.readable | BOOLEAN | Indicates whether the keep link up feature is enabled or disabled. |
payload.value.eventData.data.com.poly.wireless.keep_link_up._data.value | STRING | Stores data related to keeping a wireless link active and up. |
payload.value.eventData.entity_id | STRING | Identifies the entity associated with an update event. |
payload.value.eventTime | STRING | Represents the timestamp of an event occurrence in ISO format. |
payload.value.eventType | STRING | Identifies the type of event occurring on a device or system. |
payload.value.eventVersion | STRING | Specifies the version of the event being reported or tracked. |
payload.version | STRING | Indicates the version of the payload in various device and activity events. |
type | STRING | Indicates the event or message classification as request, response, or telemetry data. |